From e375271c09a41508ee06857fa00aa01906b589a1 Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Thu, 30 Nov 2023 18:26:10 +0100 Subject: [PATCH] Minor documentation cleanup --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a8adb4f..2f19c83 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ -# wiremock-faker-extension -Uses https://github.com/datafaker-net/datafaker to generate random, fake data for using in WireMock responses. +# Faker Extension for WireMock + +Uses [Data Faker](https://github.com/datafaker-net/datafaker) to generate random, fake data for using in WireMock responses. ## Usage ### Step 1: Add to your build file + For Maven users: ```xml @@ -20,16 +22,20 @@ For Gradle users: dependencies { implementation 'org.wiremock:wiremock-faker-extension:0.1.0' } - ``` + ### Step 2: Register the extension with your server + Then, register this extension as you would any other: ```java new WireMockServer(wireMockConfig().extensions(RandomExtension.class)); ``` + ### Step 3: Use it in your stubs! + ```yaml {{ random 'Name.first_name' }} ``` + This will generate random first names in the `en-US` locale for every request.