diff --git a/.gitignore b/.gitignore index 9fedd5a..c4dce26 100644 --- a/.gitignore +++ b/.gitignore @@ -17,3 +17,4 @@ vape vendor Vapefile +.DS_Store diff --git a/README.md b/README.md index a66f5cb..cf905e0 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,16 @@ Modern [Smoke testing](https://en.wikipedia.org/wiki/Smoke_testing) tool written in Go. Inspired by [Shisha](https://github.com/namshi/shisha) +![Success](/assets/success.png?raw=true "Success") +![Failure](/assets/failure.png?raw=true "Failure") + # How to use ## As a binary -Create a `Vapefile` file in the format: +Grab a binary from our [Releases page](https://github.com/symm/vape/releases) or build one by checking out this repo and running `make` + +Then create a `Vapefile` file in the format: ```json [ { @@ -37,7 +42,9 @@ then execute `vape http://your.domain` to run the tests ## As a container -Create the `Vapefile` file as above but be sure to mount it inside the container: +No need to download binaries or compile the project, we publish a ready made image on [Docker Hub](https://hub.docker.com/r/symm/vape/) + +Just create the `Vapefile` file as above and mount it inside a container: ```shell docker run \ diff --git a/assets/failure.png b/assets/failure.png new file mode 100644 index 0000000..ed40f16 Binary files /dev/null and b/assets/failure.png differ diff --git a/assets/success.png b/assets/success.png new file mode 100644 index 0000000..23493ee Binary files /dev/null and b/assets/success.png differ