Commit Graph

131 Commits

Author SHA1 Message Date
Lynn Cyrin
43f9b3ff1c setup versioned docs 2019-09-15 20:41:43 -07:00
Lynn Cyrin (they/them)
edd8cb2068
Bump go version to 1.10 in readme
Closes https://github.com/urfave/cli/issues/875
2019-08-24 14:44:56 -07:00
russoj88
6a25af9641
Merge branch 'master' into UpdateREADME_gopkg.in_v1 2019-08-17 10:01:35 -07:00
Lynn Cyrin (they/them)
e11183fe50
Modernize readme
I assume that people no longer care about what the package was named many years ago
2019-08-17 02:44:49 -07:00
russoj88
3bc62c4fde Mimic v2 example code from above. 2019-08-15 12:30:29 -07:00
russoj88
62b8a7cc2c Add "Using v1 releases" to table of contents. 2019-08-14 11:21:56 -07:00
russoj88
cc091db561
Update README.md
Only instruct on right way to use library.

Co-Authored-By: Lynn Cyrin (they/them) <lynncyrin@gmail.com>
2019-08-14 11:21:40 -07:00
russoj88
f529dad70c
Update README.md
Include suggestion to put example in.

Co-Authored-By: Lynn Cyrin (they/them) <lynncyrin@gmail.com>
2019-08-14 11:20:58 -07:00
russoj88
f2c26bab77 Rewrite the "pinning to v1" section. 2019-08-13 21:10:38 -07:00
Ajitem Sahasrabuddhe
286133fee5
Merge branch 'master' into combined 2019-08-08 13:33:32 +05:30
Audrius Butkevicius
815c29ffc7
Merge branch 'master' into combined 2019-08-08 07:03:49 +01:00
Ajitem Sahasrabuddhe
fd395786a2
Update README.md
remove quotes around coverage badge
2019-08-07 21:00:07 +05:30
Ajitem Sahasrabuddhe
22e1fc8419
Update README.md
add codecov.io badge
2019-08-07 14:02:52 +05:30
Ajitem Sahasrabuddhe
e2de8c7458
update readme with correct error message, add 1.12 and 1.11 to travis 2019-08-07 12:38:17 +05:30
Robert Liebowitz
8d31c5e167
Update README.md
Co-Authored-By: Ajitem Sahasrabuddhe <ajitem.s@outlook.com>
2019-08-05 07:05:07 -04:00
Robert Liebowitz
03153b9cf8 Allow combining short flags globally 2019-08-05 06:38:23 -04:00
Lynn Cyrin (they/them)
c25e4cab32
Merge branch 'master' into master 2019-08-04 12:30:28 -07:00
Lynn Cyrin (they/them)
b1a7c502eb
Merge branch 'master' into master 2019-08-03 09:36:27 -07:00
Audrius Butkevicius
b2421d1235
Merge branch 'master' into patch-1 2019-08-03 13:25:34 +01:00
Jordan Christiansen
c75a689f62 Make exit code example more clear
The purpose of this example is to show that you can exit with an error
code if a flag is unspecified, but with the code as it is, the only way
to cause a non-zero exit is by adding the flag `--ginger-crouton=false`,
which is not explained in the example.

In this new version of the example, running the command with no flag
will exit with an error, and running it with the flag will exit
normally.
2019-08-02 14:28:57 -05:00
mingrammer
ddc3453179 Update README.md 2019-03-07 00:04:18 +09:00
Christopher Waldon
3e145076ab
Clarify that altsrc supports both TOML and JSON 2018-10-12 11:30:46 -04:00
Agis Anastasopoulos
d7c3be8267
Fix README typo 2018-08-21 11:19:37 +03:00
8dc47eb3cb
Merge branch 'master' into backport-json-support 2018-02-25 16:09:48 -05:00
bc77a15c69
Merge branch 'master' into check-run-error-in-readme 2018-02-24 21:54:06 -05:00
45289ea7a0
Adjust contribution and maintainer prose per current reality 2018-02-20 12:40:43 -05:00
59e1ddb43e
Merge branch 'master' into check-run-error-in-readme 2018-02-13 15:27:04 -05:00
baude
fd5382e7a5 Combine bool short names
Adds the ability to allow the combination of bool
short-name options.  For example,

cmd foobar -ov

This is done through a bool "UseShortOptionHandler" set in
the command struct.

Built upon PR #621

Signed-off-by: baude <bbaude@redhat.com>
2017-11-13 16:29:20 -06:00
Jesse Szwedko
9838c8bcaa Update README examples to check for errors
To encourage good practices.
2017-11-11 17:46:07 -08:00
Brad Rydzewski
18a556e192 fix FilePath documentation in README.md 2017-10-31 10:29:11 -05:00
Brad Rydzewski
4cc453ba67 document field in README 2017-10-31 10:29:11 -05:00
Alan D. Cabrera
1d334f10ce Add newline before command categories
The simple formatting change adds a nice blank line before each command
category.  Documentation in README.md is also updated to be more
accurate.
2017-09-08 10:43:30 -07:00
Jesse Szwedko
e1fa109a31 Define flag source precedence in README
Fixes #646
2017-08-10 17:54:24 -07:00
John Weldon
6a70c4cc92 Add JSON InputSource to altsrc package
- Implement NewJSONSource* functions for returning an InputSource from
   various JSON data sources.
 - Copy and modify YAML tests for the JSON InputSource

Changes:

* Reverted the method calls and structs to match the v1 interface
2017-02-14 21:07:04 -08:00
Maximilian Meister
ac772237b9
command: enable ordering commands by name 2017-01-09 16:40:32 +01:00
Bo-Yi Wu
4267cd827c [ci skip] Fix template syntax error 2017-01-04 10:28:58 +08:00
Antonio Murdaca
c516bce8f1
flags: provide a type to sort flags
Signed-off-by: Antonio Murdaca <runcom@redhat.com>
2016-10-21 10:37:18 +02:00
b425397570 Merge branch 'master' into update-wording-around-gopkgin 2016-09-11 11:43:05 -04:00
Nathan Bullock
76164d6e36 Fix typo in README
cosumized -> customized
2016-09-05 07:16:05 -04:00
Jesse Szwedko
4b62cb6b33 Update wording around gopkg.in pinning to be more accurate
Since we have `v1.X` tags, gopkg.in/urfave/cli.v1 will pull the latest
tagged release rather than the `v1` branch. Since there are no tagged
`v2` releases, `gopkg.in` will pull the latest commit of that branch.

Fixes #513
2016-09-03 14:23:36 -07:00
Jesse Szwedko
b616f60886 Note TOML support in README and CHANGELOG 2016-07-31 12:11:52 -07:00
Yi EungJun
c59ec842c1 README: Remove unnecessary 'v' from version numbers
'partay version v19.99.0' sounds 'partay version version 19.99.0'
because 'v' stands for 'version'.
2016-07-25 23:44:02 +09:00
Dan Buch
06f64bd31d
Update docs and change log regarding go1.1 drop 2016-07-11 05:16:14 -04:00
Dan Buch
c20f912780
Add stronger warning about v2 volatility
and make **Notice** style more consistent
2016-06-20 10:57:45 -04:00
81892f3f5f Merge branch 'master' into readme-toc 2016-06-16 15:30:52 -04:00
Dan Buch
ee69d3c011
Generate TOC in README
and assert it is up to date
2016-06-16 11:47:19 -04:00
Dan Buch
a0e694ed72
Add UintFlag, Uint64Flag types and supporting code 2016-06-16 11:13:32 -04:00
Dan Buch
288b636ba3
Modifying full API example for more migrator exercise 2016-06-01 22:27:52 -04:00
Dan Buch
b5c48311fa
Ensure the full API example really runs 2016-06-01 14:06:51 -04:00
Dan Buch
1c81757e1f
Add more v1 API examples 2016-06-01 13:28:27 -04:00