README.md in pact_broker-2.1.1 vs README.md in pact_broker-2.2.0
- old
+ new
@@ -1,9 +1,13 @@
# Pact Broker
+[](http://badge.fury.io/rb/pact_broker)
+ [](https://travis-ci.org/pact-foundation/pact_broker) [](https://gitter.im/pact-foundation/pact_broker?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+ [](https://codeclimate.com/github/pact-foundation/pact_broker)
+ [](https://codeclimate.com/github/pact-foundation/pact_broker/coverage)
+ [](https://codeclimate.com/github/pact-foundation/pact_broker)
+ [](https://gemnasium.com/github.com/pact-foundation/pact_broker)
-[](https://travis-ci.org/pact-foundation/pact_broker) [](https://gitter.im/pact-foundation/pact_broker?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-
The Pact Broker provides a repository for consumer driven contracts created using the pact gem.
It:
* solves the problem of how to share pacts between consumer and provider projects
@@ -42,14 +46,20 @@
If you don't have a [Pact Broker CI Nerf Gun][nerf], you'll probably want to read about using pact when the consumer and provider are being written by [different teams][different-teams].
## Documentation
-See the [Pact Broker Client](https://github.com/pact-foundation/pact_broker-client) for documentation on how to publish a pact to the Pact Broker, and configure the URLs in the provider project.
+See the [wiki][wiki] for documentation on the Pact Broker.
-See the [wiki](https://github.com/pact-foundation/pact_broker/wiki) for documentation related to the Pact Broker itself.
+## Support
+* Check the [wiki][wiki] first.
+* See if there is an existing or closed [issue][issues] and raise a new issue if not.
+* See if there is an existing question on [stackoverflow][stackoverflow] tagged with `pact-broker`, and ask a new question if not.
+* Have a chat to us on the Pact [gitter][gitter].
+* Tweet us at [@pact_up][twitter] on the twitters.
+
### Screenshots
#### Index
* * *
@@ -99,11 +109,11 @@
In a hurry? Hate having to run your own infrastructure? Check out the [Hosted Pact Broker][hosted] - it's fast, it's secure and it's free!
#### Container solutions
-You can use the [Pact Broker Docker container][docker] or [Terraform on AWS][terraform]
+You can use the [Pact Broker Docker container][docker] or [Terraform on AWS][terraform]
#### Rolling your own
* Create a PostgreSQL (recommended) or MySQL (not recommended, see following note) database.
* __Note:__ It is recommended to use __PostgreSQL__ as it will support JSON search features that are planned in the future, however MySQL the other [semi supported](https://github.com/pact-foundation/pact_broker/issues/33) database.
@@ -119,5 +129,10 @@
[nerf]: https://github.com/pact-foundation/pact_broker/wiki/pact-broker-ci-nerf-gun
[different-teams]: https://github.com/realestate-com-au/pact/wiki/Using-pact-where-the-consumer-team-is-different-from-the-provider-team
[docker]: https://hub.docker.com/r/dius/pact-broker
[terraform]: https://github.com/nadnerb/terraform-pact-broker
[hosted]: https://pact.dius.com.au/?utm_source=github&utm_campaign=GITHUB_BROKER&utm_medium=github
+[wiki]: https://github.com/pact-foundation/pact_broker/wiki
+[stackoverflow]: http://stackoverflow.com/questions/tagged/pact-broker
+[twitter]: https://twitter.com/pact_up
+[gitter]: https://gitter.im/realestate-com-au/pact
+[issues]: https://github.com/pact-foundation/pact_broker/issues