From 491f6417a3734ebc19001fd4a2848d8cb38f0f62 Mon Sep 17 00:00:00 2001 From: Matt Fellows Date: Wed, 18 Jan 2017 23:43:45 +1100 Subject: [PATCH] feat(examples): update docu for e2e example --- examples/e2e/README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/examples/e2e/README.md b/examples/e2e/README.md index d0e02eccd..473318b34 100644 --- a/examples/e2e/README.md +++ b/examples/e2e/README.md @@ -22,13 +22,19 @@ Provides Animal profile information, including interests, zoo location and other Given an animal profile, recommends a suitable partner based on similar interests. -## Running +## Running the tests 1. `npm install` 1. `npm test:consumer` - Run consumer tests 1. `npm test:publish` - Publish contracts to the broker 1. `npm test:provider` - Run provider tests +# Running the API + +If you want to experiment with the API to get an understanding: + +1. `npm run provider` - Runs the provider API (animal service) +1. `npm run consumer` - Runs the consumer API (matching service) ## Viewing contracts with the Pact Broker