aboutsummaryrefslogtreecommitdiffhomepage
path: root/example/README.md
diff options
context:
space:
mode:
authorTim Lucas <t@toolmantim.com>2019-02-06 10:57:32 +1100
committerTim Lucas <t@toolmantim.com>2019-02-06 11:31:33 +1100
commit40876fe8ad7b884004ed5f47ac66ce79b0e9ad14 (patch)
treed52fc6800d57d67ccd92f9b5af391fbae6093b9d /example/README.md
parent3a4b164295f12e232ec73ab052f2928c6a8b539c (diff)
downloaddocker-puppeteer-40876fe8ad7b884004ed5f47ac66ce79b0e9ad14.tar.gz
docker-puppeteer-40876fe8ad7b884004ed5f47ac66ce79b0e9ad14.tar.zst
docker-puppeteer-40876fe8ad7b884004ed5f47ac66ce79b0e9ad14.zip
Update README.md
Diffstat (limited to 'example/README.md')
-rw-r--r--example/README.md17
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
3This 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
9git clone https://github.com/buildkite/docker-puppeteer.git
10cd docker-puppeteer/example
11
12# Build and run the example tests
13docker-compose -f docker-compose.integration-tests.yml run tests
14
15# See the screen that was generated
16ls screenshots/
17```