From 8bf9d17c4bb819b188ecea827117ad4d02476e18 Mon Sep 17 00:00:00 2001 From: Oleg Kovalov Date: Fri, 1 Dec 2023 18:24:17 +0100 Subject: [PATCH] Small doc fixes --- README.md | 8 +++----- example_test.go | 2 +- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a1dcb56..737f880 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![coverage-img]][coverage-url] [![version-img]][version-url] -Simple, useful and opinionated CLI package in Go. For config loader see [aconfig](https://github.com/cristalhq/aconfig) +Simple, useful and opinionated CLI package in Go. For config loader see [cristalhq/aconfig](https://github.com/cristalhq/aconfig) ## Rationale @@ -21,6 +21,8 @@ Popular CLI libraries (or better frameworks) have too large and unclear API, in * Auto suggesting command. * Builtin `help` and `version` commands. +See [docs][pkg-url] and [GUIDE.md](GUIDE.md) for more details. + ## Install Go version 1.17+ @@ -68,10 +70,6 @@ if err := r.Run(); err != nil { See examples: [example_test.go](example_test.go). -## Documentation - -See [these docs][pkg-url] or [GUIDE.md](GUIDE.md) for more details. - ## License [MIT License](LICENSE). diff --git a/example_test.go b/example_test.go index 165ff63..92e9a31 100644 --- a/example_test.go +++ b/example_test.go @@ -19,7 +19,7 @@ var ( nopUsage = func(cfg acmd.Config, cmds []acmd.Command) {} ) -func ExampleRunner() { +func Example() { testOut := os.Stdout testArgs := []string{"someapp", "now", "--times", "3"}