Skip to content

Commit

Permalink
Improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
andyone committed Nov 24, 2023
1 parent 46f22f4 commit 2a707a6
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,29 @@ fmtc --generate-man | sudo gzip > /usr/share/man/man1/fmtc.1.gz
### Usage

```
Usage: fmtc {options} data…
Options
--error, -E Print data to stderr
--line, -L Don't print newline at the end
--no-color, -nc Disable colors in output
--help, -h Show this help message
--version, -v Show version
Examples
fmtc "{*}Done!{!} File {#87}$file{!} successfully uploaded to {g_}$host{!}"
Print fmtc formatted message
fmtc -E "{r*}There is no user bob{!}"
Print fmtc formatted message to stderr
fmtc -nc "{*}Done!{!} File {#87}$file{!} successfully uploaded to {g_}$host{!}"
Print message without colors using -nc/--no-color option
echo "{*}Done!{!} File {#87}$file{!} successfully uploaded to {g_}$host{!}" | fmtc
Use stdin as a source of data
```

### CI Status
Expand Down

0 comments on commit 2a707a6

Please sign in to comment.