README.md in pact_broker-2.4.2 vs README.md in pact_broker-2.5.0
- old
+ new
@@ -24,11 +24,11 @@
* Dynamically generated network diagrams so you can visualise your microservice network.
* Displays provider verificaton results so you know if you can deploy safely.
* Provides badges to display pact verification statuses in your READMEs.
* Enables a pact version to be tagged (ie. "prod") so a provider can verify itself against a fixed version of a pact to ensure backwards compatibility.
* Provides webhooks to trigger a provider build when a consumer publishes a change to a pact.
-* Tracks changes between Pact versions so you can tell when a consumer has changed its expectations.
+* View diffs between Pact versions so you can tell what expectations have changed.
* [Docker Pact Broker][docker]
### How would I use the Pact Broker?
#### Step 1. Consumer CI build
@@ -122,9 +122,13 @@
* Copy the [example](/example) directory to the location you want to install the application.
* Modify the config.ru and Gemfile as desired (eg. choose database driver gem, set your database credentials. Use the "pg" gem if using Postgres and the "mysql2" gem if using MySQL)
* Please ensure you use `encoding: 'utf8'` in your Sequel options to avoid encoding issues.
* For production usage, use a web application server like [Phusion Passenger](https://www.phusionpassenger.com) or [Nginx](http://nginx.org/) to serve the Pact Broker application.
* Deploy to your location of choice.
+
+## Upgrading
+
+Please read the [UPGRADING.md](UPGRADING.md) documentation before upgrading your Pact Broker, for information on the supported upgrade paths.
[decouple]: http://techblog.realestate.com.au/enter-the-pact-matrix-or-how-to-decouple-the-release-cycles-of-your-microservices/
[pact]: https://github.com/realestate-com-au/pact
[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