From 607a940587bb19c700ce675e61c3f185f97a776f Mon Sep 17 00:00:00 2001 From: Florian Ebeling Date: Fri, 8 Dec 2023 13:53:55 +0100 Subject: [PATCH] Document new value formats --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 908e3c3..66da75f 100644 --- 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