From 829ebf9238dbb82d444e2461bfc43ba1cf131b07 Mon Sep 17 00:00:00 2001 From: evilchili Date: Sun, 31 Jul 2022 15:09:50 -0700 Subject: [PATCH] updating README.md --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index c4dfdef..253e05a 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,38 @@ Invoke the CLI: └─────────┴──────────┴──────────┴────────────────────┘ ``` +### Command-Line Help +``` +% poetry run roll-table --help + + Usage: roll-table [OPTIONS] SOURCES... + + CLI for creating roll tables. + +╭─ Arguments ───────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│ * sources SOURCES... Path to one or more yaml-formatted source file. [default: None] [required] │ +╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│ --frequency TEXT use the specified frequency from the │ +│ source file │ +│ [default: default] │ +│ --die INTEGER The size of the die for which to │ +│ create a table │ +│ [default: 20] │ +│ --collapsed --no-collapsed If True, collapse multiple die values │ +│ with the same option. │ +│ [default: collapsed] │ +│ --install-completion [bash|zsh|fish|powershell|pwsh] Install completion for the specified │ +│ shell. │ +│ [default: None] │ +│ --show-completion [bash|zsh|fish|powershell|pwsh] Show completion for the specified │ +│ shell, to copy it or customize the │ +│ installation. │ +│ [default: None] │ +│ --help Show this message and exit. │ +╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +``` + ### Library Use ```