From 4efe035267477acfbf0e09451e9fd52dc4ca54ee Mon Sep 17 00:00:00 2001 From: Bartek Pacia Date: Thu, 2 May 2024 21:24:05 +0100 Subject: [PATCH 1/2] improve readme a bit more --- README.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b288690020..a3130632f0 100644 --- a/README.md +++ b/README.md @@ -11,26 +11,31 @@ command line tools in Go featuring: - commands and subcommands with alias and prefix match support - flexible and permissive help system - dynamic shell completion for `bash`, `zsh`, `fish`, and `powershell` -- `man` and markdown format documentation generation -- input flags for simple types, slices of simple types, time, duration, and others +- no dependencies except Go standard library +- input flags for simple types, slices of simple types, time, duration, and + others - compound short flag support (`-a` `-b` `-c` can be shortened to `-abc`) +- documentation generation in `man` and Markdown (supported via the + [`urfave/cli-docs`][urfave/cli-docs] module) - input lookup from: - environment variables - plain text files - - [structured file formats supported via the `urfave/cli-altsrc` package](https://github.com/urfave/cli-altsrc) + - structured file formats (supported via the + [`urfave/cli-altsrc`][urfave/cli-docs] module) ## Documentation See the hosted documentation website at . Contents of this website are built from the [`./docs`](./docs) directory. -## Q&A +## Support -Please check the [Q&A discussions] or [ask a new question]. +Check the [Q&A discussions]. If you don't find answer to your question, [create +a new discussion]. -## License +If you found a bug or have a feature request, [create a new issue]. -See [`LICENSE`](./LICENSE). +Please keep in mind that this project is run entirely by unpaid volunteers. [test_badge]: https://github.com/urfave/cli/actions/workflows/test.yml/badge.svg [test_link]: https://github.com/urfave/cli/actions/workflows/test.yml @@ -41,4 +46,7 @@ See [`LICENSE`](./LICENSE). [codecov_badge]: https://codecov.io/gh/urfave/cli/branch/main/graph/badge.svg?token=t9YGWLh05g [codecov_link]: https://codecov.io/gh/urfave/cli [Q&A discussions]: https://github.com/urfave/cli/discussions/categories/q-a -[ask a new question]: https://github.com/urfave/cli/discussions/new?category=q-a +[create a new discussion]: https://github.com/urfave/cli/discussions/new?category=q-a +[urfave/cli-docs]: https://github.com/urfave/cli-docs +[urfave/cli-altsrc]: https://github.com/urfave/cli-altsrc +[create a new issue]: https://github.com/urfave/cli/issues/new/choose From b78ef8dd2a40bf27617684bdafc1efcee7a4fa23 Mon Sep 17 00:00:00 2001 From: Bartek Pacia Date: Thu, 2 May 2024 23:55:29 +0100 Subject: [PATCH 2/2] re-add license --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a3130632f0..415355f08b 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,11 @@ a new discussion]. If you found a bug or have a feature request, [create a new issue]. -Please keep in mind that this project is run entirely by unpaid volunteers. +Please keep in mind that this project is run by unpaid volunteers. + +### License + +See [`LICENSE`](./LICENSE). [test_badge]: https://github.com/urfave/cli/actions/workflows/test.yml/badge.svg [test_link]: https://github.com/urfave/cli/actions/workflows/test.yml