diff options
Diffstat (limited to 'example/README.md')
-rw-r--r-- | example/README.md | 17 |
1 files changed, 17 insertions, 0 deletions
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 @@ | |||
1 | # Docker Puppeteer Example | ||
2 | |||
3 | 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. | ||
4 | |||
5 | ## Running | ||
6 | |||
7 | ```shell | ||
8 | # Clone this example | ||
9 | git clone https://github.com/buildkite/docker-puppeteer.git | ||
10 | cd docker-puppeteer/example | ||
11 | |||
12 | # Build and run the example tests | ||
13 | docker-compose -f docker-compose.integration-tests.yml run tests | ||
14 | |||
15 | # See the screen that was generated | ||
16 | ls screenshots/ | ||
17 | ``` | ||