b157e8d10a
Update README.md
...
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-09-18 22:23:26 +07:00
3d59e5e89e
bump go-scalar to v1.1 and add documentation about supported types
2021-08-20 19:52:48 -07:00
91214e01ea
add an example of parsing into a map to the readme
2021-04-19 13:59:00 -07:00
04c3fdbd80
Updated readme
2020-12-20 03:07:18 +03:00
c47edd0324
add documentation and examples showing how to override the short and long option names together
2020-08-06 16:41:45 -07:00
2bc58b597b
replace coveralls badge with codecov
2020-04-17 16:37:00 -04:00
7a71aa1b20
add banner image
2020-04-17 16:09:24 -04:00
388f831e68
drop golangci since it is shutting down soon; fix pkg.go.dev link
2020-04-17 16:00:32 -04:00
40ed78b0fa
use go.dev badge
2020-04-17 15:58:00 -04:00
efbf84df4c
drop blank lines
2020-04-17 15:54:02 -04:00
499991fce1
move some stuff around in the readme header; add sourcegraph
2020-04-17 15:52:34 -04:00
1fc1a6f6df
put coverage badge back
2020-04-03 12:28:05 -04:00
9fccfd3d6a
replace travis badge with github actions badge
2020-04-03 12:24:39 -04:00
7ac7956369
drop coverage badge (adding an issue to put it back)
2020-04-03 11:59:47 -04:00
db9f869c99
Document that the placeholder tag requires v1.3.0
2020-02-23 11:44:00 -08:00
5943b1ad42
README: how to terminate a program when no subcommands are specified
...
Fixes #103
2020-01-23 18:16:28 +01:00
9d4521ce8b
Final improvements
2019-11-30 22:31:08 +03:00
c3a019cdb8
Various changes
2019-11-30 00:22:21 +03:00
e0fc08f7ad
add docs about old way of specifying defaults
2019-10-21 23:37:12 -07:00
7ac060af18
update documentation to new way of specifying defaults
2019-10-21 23:13:41 -07:00
e6003d3b6a
add subcommands to readme
2019-08-06 16:41:50 -07:00
42c2ab5ac6
Merge pull request #78 from alexflint/readme-spelling
...
minor fixes to readme
2019-04-14 17:18:01 -07:00
891a07ec29
more tweaks
2019-04-14 16:08:51 -07:00
e56211335f
minor fixes to readme
2019-04-14 16:06:27 -07:00
1ec799ffcf
update link for golangci badge
2019-04-04 09:18:22 -07:00
6b4ab7355c
add golangci badge, and fix some lint issues found by the tool
2019-04-04 09:10:24 -07:00
a6af419fff
README: update TextUnmarshaler example
...
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 <pavel.borzenkov@gmail.com>
2018-11-20 12:32:32 +03:00
fa5fe315f8
Change format from JSON to CSV
2018-05-01 12:02:44 +03:00
75bf1a1525
Fix providing multiple values via environment variables
2018-04-26 21:10:44 +03:00
51337ded77
fixed example comment, test coverage issue
2018-04-16 11:07:48 +10:00
d4cc703210
Custom parsers implementing encoding.TextMarshaler() can have default values printed via --help
2018-04-13 14:46:24 +10:00
ba9514f0be
Further clarification
2017-10-02 14:36:23 +01:00
d7961941f0
Altered help tag parsing to reduce the constraints on help text content; old behaviour is retained for backward compatibility
2017-10-02 14:18:41 +01:00
b413f8dfb0
Merge branch 'master' into master
2017-03-09 18:25:56 +01:00
9e6f80aa90
readme update
2017-03-08 20:52:02 +01:00
d4c2b35b2e
Adding separate tag option
...
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-03-04 09:13:12 +07:00
db27431153
add support for description string
2017-01-23 20:41:12 -05:00
03900620e2
add not on embedding to readme
2016-10-10 10:52:42 +10:30
f882700b72
add to readme
2016-09-08 21:26:12 -07:00
6e9648cac6
add goreportcard to readme.md
2016-07-31 10:16:17 -07:00
8fee8f7bbe
move installation instructions to top
2016-01-23 20:11:51 -08:00
95761fa14a
update readme with new additions
2016-01-23 20:08:00 -08:00
8dd29d34bf
Add support for environment variables
2016-01-18 13:42:04 -05:00
9aad09fe14
fix example code
2016-01-05 14:00:29 -08:00
f89698667c
add custom validation example to README
2016-01-05 13:57:01 -08:00
239d0c1c6f
add coveralls badge
2015-11-04 10:58:20 -08:00
5185642348
fix note on boolean flags in readme
2015-11-03 08:15:45 -08:00
60f2612c0c
separate help into WriteUsage and WriteHelp
2015-11-01 13:53:51 -08:00
bcb41ba048
add travis badge
2015-11-01 13:40:27 -08:00
beede9329a
added runnable examples
2015-11-01 11:34:22 -08:00
evgenv123
Alex Flint
Andrew Morozko
Marco Molteni
Andrew Morozko
Pavel Borzenkov
Illia Volochii
Wlazlo, Matt
Rick
K3A
Mario Hros
Kenneth Shaw
Emmanouil "Manolis" Maragkakis
brettlangdon