X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=example%2FREADME.md;fp=example%2FREADME.md;h=3f1c735cd7fb0d5ac6d08d7a7fdcbddd1a939bd3;hb=4e7c52141ab2170730089e93fb732aa1baba1b2f;hp=0000000000000000000000000000000000000000;hpb=f2ea4b9e74b9a8110490ede83d195565f57c004d;p=github%2Ffretlink%2Fdocker-puppeteer.git

diff --git a/example/README.md b/example/README.md
new file mode 100644
index 0000000..3f1c735
--- /dev/null
+++ b/example/README.md
@@ -0,0 +1,17 @@
+# Docker Puppeteer Example
+
+This as an example of using the Docker Puppeteer docker image to run Mocha tests against a linked Docker Compose web service, and capturing a screenshot into a local `./screenshots` directory.
+
+## Running
+
+```shell
+# Clone this example
+git clone https://github.com/buildkite/docker-puppeteer.git
+cd docker-puppeteer/example
+
+# Build and run the example tests
+docker-compose -f docker-compose.integration-tests.yml run tests
+
+# See the screen that was generated
+ls screenshots/
+```