From cc6666b70595ee9154b1f3aef03dec0258eb2f62 Mon Sep 17 00:00:00 2001 From: Beth Skurrie Date: Mon, 2 Oct 2017 15:07:46 +1100 Subject: [PATCH] docs(readme): add note about badges being publicly accessible --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0ac495af..8d3a8007 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ For an sqlite database (only recommended for investigation/spikes, as it will be * Apart from creating a database no further preparation is required. ## Using basic auth -Run your container with `PACT_BROKER_BASIC_AUTH_USERNAME` and `PACT_BROKER_BASIC_AUTH_PASSWORD` set to enable basic auth for the pact broker application. +Run your container with `PACT_BROKER_BASIC_AUTH_USERNAME` and `PACT_BROKER_BASIC_AUTH_PASSWORD` set to enable basic auth for the pact broker application. Note that the [verification status badges][badges] are not protected by basic auth, so that you may embed them in README markdown. ## Running with Docker Compose @@ -57,3 +57,5 @@ curl -v http://$DOCKER_HOST # you can visit in your browser too! ``` _NOTE: this image should be modified before using in Production, in particular, the use of hard-coded credentials_ + +[badges]: https://github.com/pact-foundation/pact_broker/wiki/Provider-verification-badges