Skip to content

Commit

Permalink
chore(docs): make provider states endpoint clearer
Browse files Browse the repository at this point in the history
  • Loading branch information
mefellows committed Jan 22, 2017
1 parent c78616b commit f9edcb5
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Pact Provider Verification

This setup simplifies Pact Provider [verification](https://github.com/realestate-com-au/pact#2-tell-your-provider-that-it-needs-to-honour-the-pact-file-you-made-earlier)
This setup simplifies Pact Provider [verification](https://docs.pact.io/documentation/verifying_pacts.html)
process in any language, wrapping the Ruby implementation into a cross-platform,
binary-like CLI tool.

**Features**:

* Verify Pacts against Pacts published to an http endpoint, such as a [Pact Broker](https://github.com/bethesque/pact_broker)
* Verify local `*.json` Pacts on the file system
* Works with Pact [provider states](https://github.com/realestate-com-au/pact/wiki/Provider-states) should you need them
* Works with Pact [provider states](https://docs.pact.io/documentation/provider_states.html) should you need them

## Installation

Expand All @@ -28,10 +28,11 @@ Run `pact-provider-verifier help` for command line options.

## Examples

See the [examples](examples) directory for a real working API example:
See the [example](examples) for a demonstration with a [Sinatra](http://www.sinatrarb.com/) API:

```
cd examples
bundle install
./test.sh
```

Expand All @@ -50,12 +51,16 @@ cd examples

Execute pact provider verification against a provider which implements the following:

* an http get endpoint which returns pact provider_states by consumer
* an http get endpoint which returns the available [Provider States](https://docs.pact.io/documentation/provider_states.html) by consumer

{
"myConsumer": [
"customer is logged in",
"customer has a million dollars"
"SomeUI": [
"customer A is logged in",
"customer A has a million dollars"
],
"BackendAPI": [
"customer A is logged in",
"there are no customers"
]
}

Expand Down

0 comments on commit f9edcb5

Please sign in to comment.