fix readme to reflect cli changes
This commit is contained in:
parent
b440555138
commit
bfb26b61cf
1 changed files with 6 additions and 9 deletions
15
README.md
15
README.md
|
@ -72,14 +72,11 @@ A port of Cat2Text to Rust, with extra functionality, better documentation, and
|
||||||
Usage: cat2text <COMMAND>
|
Usage: cat2text <COMMAND>
|
||||||
|
|
||||||
Commands:
|
Commands:
|
||||||
generate-bash-completions Generate bash completions
|
gen-completion Generate shell completions
|
||||||
generate-zsh-completions Generate zsh completions
|
encode Encodes text/data to mrow~
|
||||||
generate-fish-completions Generate fish completions
|
decode Decodes mrow~ to text/data
|
||||||
generate-powershell-completions Generate PowerShell completions,
|
benchmark
|
||||||
encode Encodes text/data to mrow~
|
help Print this message or the help of the given subcommand(s)
|
||||||
decode Decodes mrow~ to text/data
|
|
||||||
benchmark
|
|
||||||
help Print this message or the help of the given subcommand(s)
|
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
-h, --help Print help
|
-h, --help Print help
|
||||||
|
@ -103,4 +100,4 @@ For example, `cat2text encode 'i love cats'` to encode `i love cats` in text mod
|
||||||
|
|
||||||
### Shell completions
|
### Shell completions
|
||||||
|
|
||||||
To generate shell completions, you can run `cat2text generate-$(basename $SHELL)-completions | source` on *nix systems using bash, zsh, or fish.
|
To generate shell completions, you can run `cat2text gen-completion $(basename $SHELL) | source` on *nix systems using bash, zsh, or fish.
|
||||||
|
|
Loading…
Add table
Reference in a new issue