Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README by removing most of it
- Loading branch information
1 parent
4863da0
commit 18f0005
Showing
1 changed file
with
6 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,8 @@ | ||
# Welcome to urfave/cli | ||
# Welcome to urfave/cli-docs/v3 | ||
|
||
[![Run Tests](https://github.com/urfave/cli/actions/workflows/cli.yml/badge.svg)](https://github.com/urfave/cli/actions/workflows/cli.yml) | ||
[![Go Reference](https://pkg.go.dev/badge/github.com/urfave/cli/v3.svg)](https://pkg.go.dev/github.com/urfave/cli/v3) | ||
[![Go Report Card](https://goreportcard.com/badge/github.com/urfave/cli/v3)](https://goreportcard.com/report/github.com/urfave/cli/v3) | ||
[![codecov](https://codecov.io/gh/urfave/cli/branch/main/graph/badge.svg?token=t9YGWLh05g)](https://codecov.io/gh/urfave/cli) | ||
[![Run Tests](https://github.com/urfave/cli-docs/actions/workflows/main.yml/badge.svg)](https://github.com/urfave/cli-docs/actions/workflows/main.yml) | ||
[![Go Reference](https://pkg.go.dev/badge/github.com/urfave/cli-docs/v3.svg)](https://pkg.go.dev/github.com/urfave/cli-docs/v3) | ||
[![Go Report Card](https://goreportcard.com/badge/github.com/urfave/cli-docs/v3)](https://goreportcard.com/report/github.com/urfave/cli-docs/v3) | ||
|
||
urfave/cli is a **declarative**, simple, fast, and fun package for building 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 | ||
- compound short flag support (`-a` `-b` `-c` :arrow_right: `-abc`) | ||
- input lookup from: | ||
- environment variables | ||
- plain text files | ||
- [structured file formats supported via the `urfave/cli-altsrc` package](https://github.com/urfave/cli-altsrc) | ||
|
||
## Documentation | ||
|
||
More documentation is available in [`./docs`](./docs) or the hosted documentation site published from the latest release | ||
at <https://cli.urfave.org>. | ||
|
||
## Q&A | ||
|
||
Please check the [Q&A discussions](https://github.com/urfave/cli/discussions/categories/q-a) or [ask a new | ||
question](https://github.com/urfave/cli/discussions/new?category=q-a). | ||
|
||
## License | ||
|
||
See [`LICENSE`](./LICENSE) | ||
urfave/cli-docs/v3 is an extended documentation library for use | ||
with urfave/cli/v3. |