Skip to content

Commit 7da1657

Browse files
committed
Improve composition example in doc
1 parent 75cf7b3 commit 7da1657

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,12 @@ It provides the following commands:
4040

4141
It follows the Unix philosophy of [“Do one thing and do it well“](https://en.wikipedia.org/wiki/Unix_philosophy#Do_One_Thing_and_Do_It_Well) by performing a single function and beeing composable.
4242

43-
Composition example (download and scan a changelog):
43+
Composition example:
44+
1. download a changelog (`curl`)
45+
2. summarize its content as json (`heylogs`)
46+
3. colorize the output (`bat`).
4447
```bash
45-
curl -s https://raw.githubusercontent.com/olivierlacan/keep-a-changelog/main/CHANGELOG.md | heylogs scan -
48+
curl -s https://raw.githubusercontent.com/olivierlacan/keep-a-changelog/main/CHANGELOG.md | heylogs scan - -f json | bat -l json
4649
```
4750

4851
### Using in a GitHub action

0 commit comments

Comments
 (0)