Skip to content

Commit 7e274de

Browse files
authored
docs: add scarf telemetry (#188)
1 parent 88c0dc4 commit 7e274de

1 file changed

Lines changed: 18 additions & 4 deletions

File tree

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ This tool provides an amalgamated CLI of all the Pact CLI tools available in the
1414
[![size: amd64](https://badgen.net/docker/size/pactfoundation/pact-cli/latest/amd64?icon=docker&label=size%3Aamd64)](https://hub.docker.com/r/pactfoundation/pact-cli)
1515
[![size: arm64](https://badgen.net/docker/size/pactfoundation/pact-cli/latest/arm64?icon=docker&label=size%3Aarm64)](https://hub.docker.com/r/pactfoundation/pact-cli)
1616

17+
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=1625ac12-1964-4715-995b-848a5ac3cc34&page=README" />
18+
1719
## Platforms
1820

1921
Multi-platform images are available, and can be used cross-platform by setting the `platform` flag.
@@ -47,7 +49,7 @@ If you are using a Pact Broker with bearer token authentication (eg. PactFlow),
4749
### Help
4850

4951
```
50-
$ docker run --rm pactfoundation/pact-cli:latest help
52+
$ docker run --rm docker.swagger.io/pactfoundation/pact-cli:latest help
5153
Commands:
5254
help [COMMAND] # Describe available commands or one specific command
5355
mock-server # Run a Pact mock server
@@ -63,7 +65,7 @@ Commands:
6365
version # Print the version of the CLI
6466
6567
66-
$ docker run --rm pactfoundation/pact-cli:latest pact-broker help
68+
$ docker run --rm docker.swagger.io/pactfoundation/pact-cli:latest pact-broker help
6769
Commands:
6870
pact-broker can-i-deploy -a, --pacticipant=PACTICIPANT -b, --broker-base-url=BRO...
6971
pact-broker create-version-tag -a, --pacticipant=PACTICIPANT -b, --broker-base-u...
@@ -266,7 +268,7 @@ docker run --rm \
266268
To meet with [Docker consistency rules](https://github.com/docker-library/official-images#consistency) `sh` access is provided, _NOTE:_ `bash` is not installed in the container
267269

268270
```
269-
$ docker run --rm pactfoundation/pact-cli sh -c 'ls'
271+
$ docker run --rm docker.swagger.io/pactfoundation/pact-cli sh -c 'ls'
270272
Gemfile
271273
Gemfile.lock
272274
bin
@@ -277,7 +279,7 @@ pact-cli.gemspec
277279
```
278280

279281
```
280-
$ docker run --rm pactfoundation/pact-cli ls
282+
$ docker run --rm docker.swagger.io/pactfoundation/pact-cli ls
281283
Gemfile
282284
Gemfile.lock
283285
bin
@@ -294,3 +296,15 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/pact-f
294296
## License
295297

296298
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
299+
300+
## Anonymized analytics
301+
302+
`pactfoundation/pact-broker` uses [Scarf](https://scarf.sh/) to collect [anonymized download analytics](https://about.scarf.sh/about). These analytics help support the maintainers of this image and ONLY run when you pull the image through the Scarf gateway (the pull commands shown throughout this README). To opt out, pull the image directly from Docker Hub:
303+
304+
```sh
305+
docker pull pactfoundation/pact-broker
306+
```
307+
308+
Alternatively, block `static.scarf.sh` at the network level (or disable image loading in your browser when viewing this README) to disable the README impression pixel.
309+
310+
For more information, see [docs.pact.io/telemetry](https://docs.pact.io/telemetry).

0 commit comments

Comments
 (0)