]> git.immae.eu Git - github/fretlink/docker-puppeteer.git/blobdiff - README.md
Merge pull request #3 from paulrbr-fl/add-git-bin
[github/fretlink/docker-puppeteer.git] / README.md
index b58eff51c9cddc930d5b173aac21029167be8f5b..ea05d3052c81a156d150919781459e02ba69442c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,18 +1,21 @@
 # Docker Puppeteer
 
-A Puppeteer Docker image based on the code here (Apache 2.0 license):
-https://github.com/GoogleChrome/puppeteer/blob/master/docs/troubleshooting.md#running-puppeteer-in-docker
+A Node + Puppeteer base image for running Puppeteer scripts. Add your own tools (such as Jest, Mocha, etc), link services you want to test via Docker Compose, and run your Puppeteer scripts with a headless Chromium.
 
-An example for how to use:
+## Versions
 
-```Dockerfile
-FROM buildkite/puppeteer
+See the list of [Docker Hub tags](https://hub.docker.com/r/buildkite/puppeteer/tags/) for Puppeteer versions available.
 
-RUN npm install mocha
-ENV PATH="${PATH}:/node_modules/.bin"
+## Example
 
-# The `tests` dir is expected to be mounted into here
-WORK_DIR /home/pptr
+See the [example directory](example) for a complete Docker Compose example, showing how to run Puppeteer against a linked Docker Compose web service.
 
-CMD ["mocha", "--recursive", "tests"]
-```
\ No newline at end of file
+## Dependent Services
+
+This image includes [wait-for-it.sh](https://github.com/vishnubob/wait-for-it) which can be useful if you need to wait for a dependent web service to start accepting requests before your Puppeteer container attempts connecting to it. See [the example](example) for usage.
+
+## Releasing
+
+1. Create a new release on GitHub. The image is tagged with the same version as Puppeteer.
+2. Docker Hub automatically builds images for the tag.
+3. There is no step 3.