summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAndrew Morozko <[email protected]>2019-11-30 00:22:21 +0300
committerAndrew Morozko <[email protected]>2019-11-30 00:22:21 +0300
commitc3a019cdb8116ae3b4a928c2a14efd83df7f34aa (patch)
tree04b6fdab240fb204221af4a500ca170eaf3972fd /README.md
parent904e03926794663089b73d52a02def065d819200 (diff)
Various changes
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1f02559..ae0c567 100644
--- a/README.md
+++ b/README.md
@@ -148,6 +148,32 @@ var args struct {
arg.MustParse(&args)
```
+### Custom placeholders
+
+```go
+var args struct {
+ Input string `arg:"positional" placeholder:"SRC"`
+ Output []string `arg:"positional" placeholder:"DST"`
+ Optimize int `arg:"-O" help:"optimization level" placeholder:"LEVEL"`
+ MaxJobs int `arg:"-j" help:"maximum number of simultaneous jobs" placeholder:"N"`
+}
+arg.MustParse(&args)
+```
+```shell
+$ ./example -h
+Usage: example [--optimize LEVEL] [--maxjobs N] SRC [DST [DST ...]]
+
+Positional arguments:
+ SRC
+ DST
+
+Options:
+ --optimize LEVEL, -O LEVEL
+ optimization level
+ --maxjobs N, -j N maximum number of simultaneous jobs
+ --help, -h display this help and exit
+```
+
### Default values (before v1.2)
```go