Skip to content

Commit

Permalink
Update readme (#18)
Browse files Browse the repository at this point in the history
  • Loading branch information
symm authored Jul 4, 2017
1 parent a24a123 commit dde9c75
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 2 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ vape
vendor

Vapefile
.DS_Store
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
[
{
Expand All @@ -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 \
Expand Down
Binary file added assets/failure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/success.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit dde9c75

Please sign in to comment.