Skip to content

Commit

Permalink
docs: update readme (#26)
Browse files Browse the repository at this point in the history
  • Loading branch information
balazs4 authored Jul 22, 2022
1 parent f336840 commit 40df66d
Showing 1 changed file with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
curl -i <url> | alola | fx .
```

- glue beetween `curl -i` and cli JSON parser tool of your choice like `jq` or `fx`
- glue beetween `curl -i` and cli JSON parser tool of your choice like [`jq`](https://github.com/stedolan/jq) or [`fx`](https://github.com/antonmedv/fx)
- it was built with unix-philosophy in the mind
- runs assertions on JSON
- no bail-out: it runs every assertions
Expand Down Expand Up @@ -87,7 +87,7 @@ curl -i https://ewqfsixnkkhp3syjy65heuhkou0dogwr.lambda-url.eu-central-1.on.aws/
| fx 'res => res.body.name + " by " + res.body.author'
```

### assertions
## assertions

```sh
<key> should be <expected-value>
Expand All @@ -98,7 +98,7 @@ curl -i https://ewqfsixnkkhp3syjy65heuhkou0dogwr.lambda-url.eu-central-1.on.aws/

[more details](./e2e.sh)

### configuration
## configuration

You can configure `alola` with the following environment variables:

Expand All @@ -107,10 +107,6 @@ You can configure `alola` with the following environment variables:
| `ALOLA_REPORT` | result reporter | text | text,json |
| `ALOLA_CUSTOM` | any resolvable path to the custom assertions | [./.alola.js](./.alola.js) | |

## complementary projects

- [fx](https://github.com/antonmedv/fx)

## author

balazs4 - https://twitter.com/balazs4

0 comments on commit 40df66d

Please sign in to comment.