summaryrefslogtreecommitdiff
path: root/README.md
AgeCommit message (Collapse)Author
2024-09-07Add global env prefix example to READMEHugo Hromic
* Also made newline separations around sections consistent * Also fixed usage of `p.Parse()` in env variable ignore example
2024-09-05update api docs for Parser.ParseAlex Flint
2024-09-04add info to README about programmatically reproducing behavior of MustParseAlex Flint
2024-06-30Merge pull request #224 from hhromic/better-version-v2Alex Flint
Fix usage writing when using custom version flag
2024-06-30Merge pull request #233 from testwill/typoAlex Flint
fix: typo
2024-06-30Add note for version flag overriding to READMEHugo Hromic
2024-02-28add an example for environment vars with arg namesJames Shubin
If you want to specify both of these, and if they should have different names, then this shows you how it can be done.
2023-11-15fix: typoguoguangwu
Signed-off-by: guoguangwu <[email protected]>
2022-09-17Feat: Add epilog after help textSebastiaan Pasterkamp
Similar to the Description at the top of the help text an Epilog is added at the bottom. Resolves #189
2022-01-02Add 'IgnoreDefault' optionSebastiaan Pasterkamp
2021-09-18Update README.mdAlex Flint
2021-09-18Update README.mdevgenv123
Hi! As a first-time user of your great package I got a little bit confused on using command line args and env vars together, so it took me some time to make testing and I propose to save this time for other people by adding relevant edits to README.md
2021-08-20bump go-scalar to v1.1 and add documentation about supported typesAlex Flint
2021-04-19add an example of parsing into a map to the readmeAlex Flint
2020-12-20Updated readmeAndrew Morozko
2020-08-06add documentation and examples showing how to override the short and long ↵Alex Flint
option names together
2020-04-17replace coveralls badge with codecovAlex Flint
2020-04-17add banner imageAlex Flint
2020-04-17drop golangci since it is shutting down soon; fix pkg.go.dev linkAlex Flint
2020-04-17use go.dev badgeAlex Flint
2020-04-17drop blank linesAlex Flint
2020-04-17move some stuff around in the readme header; add sourcegraphAlex Flint
2020-04-03put coverage badge backAlex Flint
2020-04-03replace travis badge with github actions badgeAlex Flint
2020-04-03drop coverage badge (adding an issue to put it back)Alex Flint
2020-02-23Document that the placeholder tag requires v1.3.0Alex Flint
2020-01-23README: how to terminate a program when no subcommands are specifiedMarco Molteni
Fixes #103
2019-11-30Final improvementsAndrew Morozko
2019-11-30Various changesAndrew Morozko
2019-10-21add docs about old way of specifying defaultsAlex Flint
2019-10-21update documentation to new way of specifying defaultsAlex Flint
2019-08-06add subcommands to readmeAlex Flint
2019-04-14Merge pull request #78 from alexflint/readme-spellingAlex Flint
minor fixes to readme
2019-04-14more tweaksAlex Flint
2019-04-14minor fixes to readmeAlex Flint
2019-04-04update link for golangci badgeAlex Flint
2019-04-04add golangci badge, and fix some lint issues found by the toolAlex Flint
2018-11-20README: update TextUnmarshaler examplePavel Borzenkov
Values are much more convenient to use in argument structs, so update README to use them instead of pointers in the example as we now support this. Signed-off-by: Pavel Borzenkov <[email protected]>
2018-05-01Change format from JSON to CSVIllia Volochii
2018-04-26Fix providing multiple values via environment variablesIllia Volochii
2018-04-16fixed example comment, test coverage issueWlazlo, Matt
2018-04-13Custom parsers implementing encoding.TextMarshaler() can have default values ↵Wlazlo, Matt
printed via --help
2017-10-02Further clarificationRick
2017-10-02Altered help tag parsing to reduce the constraints on help text content; old ↵Rick
behaviour is retained for backward compatibility
2017-03-09Merge branch 'master' into masterK3A
2017-03-08readme updateMario Hros
2017-03-04Adding separate tag optionKenneth Shaw
As outlined in #49, there is a need to mimic the behavior of other applications by interweaving positional and non-positional parameters. This change adds the 'separate' option that will force a arg of type []string to only read the next supplied value. For example, when dealing with the following arg type: var MyArgs struct { Pos []string `arg:"positional"` Separate []string `arg:"-s,separate"` } This commit will parse the following command line: ./app pos1 pos2 -s=separate1 -s=separate2 pos3 -s=separate3 pos4 Such that MyArgs.Pos will be [pos1 pos2 pos3 pos4] and MyArgs.Separate will be [separate1 separate2 separate3]. Unit tests for the above have also been written and are included in this commit, as well as the addition of a section to README.md and an example func in example_test.go. Fixes #49
2017-01-23add support for description stringEmmanouil "Manolis" Maragkakis
2016-10-10add not on embedding to readmeAlex Flint
2016-09-08add to readmeAlex Flint