Skip to content

Commit

Permalink
improve readme a bit more
Browse files Browse the repository at this point in the history
  • Loading branch information
bartekpacia committed May 2, 2024
1 parent c44118c commit 4efe035
Showing 1 changed file with 16 additions and 8 deletions.
24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://cli.urfave.org>. 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
Expand All @@ -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

0 comments on commit 4efe035

Please sign in to comment.