Skip to content

Commit

Permalink
Small doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
cristaloleg committed Dec 1, 2023
1 parent f083991 commit 8bf9d17
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 6 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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+
Expand Down Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion example_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"}

Expand Down

0 comments on commit 8bf9d17

Please sign in to comment.