From 18f000590efa89b6b451e9e77b58c8c6cd635f89 Mon Sep 17 00:00:00 2001 From: Dan Buch Date: Fri, 23 Jun 2023 21:29:09 -0400 Subject: [PATCH] Update README by removing most of it --- README.md | 37 ++++++------------------------------- 1 file changed, 6 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index ffedad05..817f4814 100644 --- a/README.md +++ b/README.md @@ -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 . - -## 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.