Skip to content

Commit

Permalink
Add readme info
Browse files Browse the repository at this point in the history
  • Loading branch information
TomWright committed Mar 26, 2020
1 parent ce99061 commit 1564729
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,24 @@

A package used to run API tests defined in JSON files.

## Usage

### Install
Download an executable from the [latest release](https://github.com/TomWright/apitestr/releases/latest).
You may have to `chmod +x` the download file.

Or build from source:
```
git clone git@github.com:TomWright/apitestr.git
cd apitestr
go build -o apitestr cmd/app/main.go
```

### Run the tests
```
apitestr -tests ./tests -base http://localhost:8080
```

## Tests
Tests are contained in a single JSON file - [Example test here](tests/example.json).

Expand Down

0 comments on commit 1564729

Please sign in to comment.