example/README.md

   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 ```