From be1f87dcae38880a7331fbc026f6a39633f65449 Mon Sep 17 00:00:00 2001
From: Ronald Holshausen <rholshausen@dius.com.au>
Date: Mon, 15 Dec 2014 19:27:35 +1100
Subject: [PATCH] updated readme to include docs about pact junit rule

---
 pact-jvm-consumer-junit/README.md | 44 +++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)

diff --git a/pact-jvm-consumer-junit/README.md b/pact-jvm-consumer-junit/README.md
index fd9b150259..4c4863d1e6 100644
--- a/pact-jvm-consumer-junit/README.md
+++ b/pact-jvm-consumer-junit/README.md
@@ -78,6 +78,48 @@ public class ExampleJavaConsumerPactTest extends ConsumerPactTest {
 }
 ```
 
+### Using the Pact JUnit Rule
+
+Thanks to @warmuuh we have a JUnit rule that simplifies running Pact consumer tests. To use it, create a test class
+and then add the rule:
+
+#### 1. Add the Pact Rule to your test class.
+
+```java
+    @Rule
+    public PactRule rule = new PactRule("localhost", 8080, this);
+```
+
+#### 2. Annotate a method with Pact that returns a pact fragment
+
+```java
+    @Pact(state="test state", provider="test_provider", consumer="test_consumer")
+    public PactFragment createFragment(PactDslWithState builder) {
+        return builder
+            .uponReceiving("ExampleJavaConsumerPactRuleTest test interaction")
+                .path("/")
+                .method("GET")
+            .willRespondWith()
+                .status(200)
+                .body("{\"responsetest\": true}")
+            .toFragment();
+    }
+```
+
+#### 3. Annotate your test method with PactVerification to have it run in the context of a mock server setup with the appropriate pact from step 2
+
+```java
+    @Test
+    @PactVerification("test state")
+    public void runTest() {
+        Map expectedResponse = new HashMap();
+        expectedResponse.put("responsetest", true);
+        assertEquals(new ConsumerClient("http://localhost:8080").get("/"), expectedResponse);
+    }
+```
+
+For an example, have a look at [ExampleJavaConsumerPactRuleTest](src/test/java/au/com/dius/pact/consumer/ExampleJavaConsumerPactRuleTest.java)
+
 ### Using the Pact DSL directly
 
 Sometimes it is not convenient to use the ConsumerPactTest as it only allows one test per test class. The DSL can be
@@ -205,6 +247,8 @@ For example:
         .body("{\"hello\": \"harry\"}")
 ```
 
+##
+
 ## Debugging pact failures
 
 When the test runs, Pact will start a mock provider that will listen for requests and match them against the expectations