Skip to content

Commit

Permalink
docs: improve CLI commands readability (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
bgatellier authored Aug 16, 2023
1 parent cd1a134 commit 256f9f2
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,10 @@ In the following commands:
### With the configuration as an inlined JSON

```shell
docker run --rm --env HEART_SLACK_API_TOKEN=xoxb-rest-of-token fabernovel/heart:latest lighthouse --config '{"url":"https://heart.fabernovel.com"}' --only-listeners=slack
docker run --rm\
--env HEART_SLACK_API_TOKEN=xoxb-rest-of-token\
fabernovel/heart:latest\
lighthouse --config '{"url":"https://heart.fabernovel.com"}' --only-listeners=slack
```

💡 Heart as been designed to trigger all installed listener modules.
Expand All @@ -65,7 +68,11 @@ To achieve that, you will have to map the host filesystem
with the one from the container with the `--volume` option of the command:

```shell
docker run --rm --volume "$(pwd)/ci/config:/usr/heart/config" --env HEART_SLACK_API_TOKEN=xoxb-remaining_token fabernovel/heart:latest lighthouse --config config/lighthouse.json --only-listeners=slack
docker run --rm\
--volume "$(pwd)/ci/config:/usr/heart/config"\
--env HEART_SLACK_API_TOKEN=xoxb-rest-of-token\
fabernovel/heart:latest\
lighthouse --config config/lighthouse.json --only-listeners=slack
```

💡 Explainations:
Expand Down

0 comments on commit 256f9f2

Please sign in to comment.