Skip to content

Commit 97a60f9

Browse files
committedOct 1, 2017
feat(readme): add detailed usage notes generated from each tool
1 parent 3f5b1a2 commit 97a60f9

File tree

2 files changed

+17
-5
lines changed

2 files changed

+17
-5
lines changed
 

‎packaging/README.md.template

+14-5
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,20 @@ This version (<%= ENV.fetch('VERSION') %>) of the Pact standalone executables pa
1414

1515
## Usage
1616

17-
* Once the package has been extracted:
17+
### pact-mock-service
1818

1919
```
20-
cd pact/bin
21-
./pact-mock-service --help start # will display the options for the mock service
22-
./pact-provider-verifier --help verify # will display the options for the verifier
23-
./pact-publish --help # will display the options for publishing
20+
<%= pact_mock_service_usage %>
21+
```
22+
23+
### pact-provider-verifier
24+
25+
```
26+
<%= pact_provider_verifier_usage %>
27+
```
28+
29+
### pact-publish
30+
31+
```
32+
<%= pact_publish_usage %>
2433
```

‎packaging/generate_readme_contents.rb

+3
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,7 @@
55
require 'pact/provider_verifier/version'
66
require 'pact_broker/client/version'
77

8+
pact_mock_service_usage = `bundle exec pact-mock-service help` + `bundle exec pact-mock-service help service`
9+
pact_provider_verifier_usage = `bundle exec pact-provider-verifier help`
10+
pact_publish_usage = `bundle exec pact-publish help`
811
puts ERB.new(ARGF.read).result(binding)

0 commit comments

Comments
 (0)