Document new value formats

febeling · Dec 8, 2023 · 607a940 · 607a940
1 parent 3140cde
commit 607a940
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -17,6 +17,8 @@ Command line options package with narrow scope and ease of use.
 - support boolean options (flags)
 - support repeat options (`-n first -n second,third` to `["first", "second", "third"]`)
 - long and short option names (e.g. `-s`, `--long`)
+- use `=` for long format option value (`--name=val`)
+- append value to short format option (`-nval`)
 - no assumptions about defaults (leave room for config files, and env vars)
 - no assumptions about subcommands (but easy to accomodate)
 - explicit failure result instead of exceptions