Skip to content

Commit

Permalink
add a readme section for full cli usage
Browse files Browse the repository at this point in the history
  • Loading branch information
tmck-code committed Mar 19, 2024
1 parent cf7b66b commit 3b2fff1
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Print pokemon in the CLI! An adaptation of the classic "cowsay"
- [pokesay](#pokesay)
- [One-line installs](#one-line-installs)
- [Usage](#usage)
- [Full Usage](#full-usage)
- [How it works](#how-it-works)
- [Building binaries](#building-binaries)
- [On your host OS](#on-your-host-os)
Expand Down Expand Up @@ -64,6 +65,38 @@ echo 'fortune | pokesay' >> $HOME/.bashrc

> _Note: The pokesay tool is intended to only be used with piped text input from STDIN, entering text by typing (or other methods) might not work as expected!_

### Full Usage

> Run pokesay with `-h` or `--help` to see the full usage

```shell
Usage: pokesay [-bCfhjLlsuvW] [-c value] [-n value] [-t value] [-w value] [parameters ...]
-b, --info-border draw a border around the info box
-c, --category=value
choose a pokemon from a specific category
-C, --no-category-info
do not print pokemon category information in the info box
-f, --fastest run with the fastest possible configuration (--nowrap &
--notabspaces)
-h, --help display this help message
-j, --japanese-name
print the japanese name in the info box
-L, --list-categories
list all available categories
-l, --list-names list all available names
-n, --name=value choose a pokemon from a specific name
-s, --no-tab-spaces
do not replace tab characters (fastest)
-t, --tab-width=value
replace any tab characters with N spaces [4]
-u, --unicode-borders
use unicode characters to draw the border around the speech
box (and info box if --info-border is enabled)
-v, --verbose print verbose output
-W, --no-wrap disable text wrapping (fastest)
-w, --width=value the max speech bubble width [80]
```
---
## How it works
Expand Down

0 comments on commit 3b2fff1

Please sign in to comment.