Skip to content

Commit

Permalink
docs(Readme): remove unnecessary noise from the readme, update image …
Browse files Browse the repository at this point in the history
…dimensions
  • Loading branch information
maciejsmolinski committed Aug 6, 2019
1 parent 2f8563d commit cacb25b
Showing 1 changed file with 1 addition and 16 deletions.
17 changes: 1 addition & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

🤹‍♂️A simple, opinionated web hooks manager. Built with PureScript.

<img src="https://raw.githubusercontent.com/maciejsmolinski/orchy/master/assets/success.gif" width="490" height="325"/>
<img src="https://raw.githubusercontent.com/maciejsmolinski/orchy/master/assets/success.gif" width="650" height="333"/>

## Installation

Expand Down Expand Up @@ -57,37 +57,26 @@ while the browser will show only a `success` message, the server will give you m
When `configuration.json` file is missing:

```shell
$ orchy

2019/08/05 23:55:40 err Failure reading configuration.json
```

When `configuration.json` has a wrong format:

```shell
$ orchy

2019/08/05 23:56:40 err Configuration file is not structured properly
2019/08/05 23:56:40 Error at array index 0: Error at property "id": Type mismatch: expected String, found Undefined
```

When selected definition is not present in the configuration:

```shell
$ orchy
Orchy server is running at http:https://localhost:8181

2019/08/06 23:57:52 log Incoming request /run?definition=unknown&secret=unknown-token
2019/08/06 23:57:52 err Definition with provided id and secret not found
```

When definition exists but one of the commands fails:

```shell
$ orchy

Orchy server is running at http:https://localhost:8181

2019/08/06 00:02:20 log Incoming request /run?definition=main&secret=secret-token
2019/08/06 00:02:20 log Running definition "main"
2019/08/06 00:02:20 log Executing git branch
Expand All @@ -99,10 +88,6 @@ Orchy server is running at http:https://localhost:8181
Finally, when everything succeeds:

```shell
$ orchy

Orchy server is running at http:https://localhost:8181

2019/08/06 00:03:30 log Incoming request /run?definition=main&secret=secret-token
2019/08/06 00:03:30 log Running definition "main"
2019/08/06 00:03:30 log Executing git branch
Expand Down

0 comments on commit cacb25b

Please sign in to comment.