Skip to content

Commit 71d7a26

Browse files
committed
docs: basic readme intro
1 parent e153aac commit 71d7a26

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

docs/README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,23 @@
22

33
[![Go Reference](https://pkg.go.dev/badge/github.com/steverusso/cli.svg)](https://pkg.go.dev/github.com/steverusso/cli)
44

5-
This is primarily a library to parse command line arguments. Anything it offers in
6-
addition to that (such as optionally reading values from environment variables as well)
7-
should be invisible to the user who wants to simply parse command line arguments.
5+
```shell
6+
go get github.com/steverusso/cli@latest
7+
```
8+
9+
## Features
10+
11+
* Lightweight, simple, composable.
12+
* There are **zero** external dependencies.
13+
* No required project / file layout or recommended use of a generator.
14+
* No reflection.
15+
* Fully POSIX-compliant flags (including short & long versions). (TODO reword and check if true)
16+
* Inputs can additionally be parsed from environment variables and / or default values.
17+
* Nested subcommands.
18+
* Clean, well-formatted help messages by default.
19+
* Ability to build custom help messages.
20+
21+
> [!NOTE]
22+
> This is primarily a library to parse command line arguments. Anything it offers in
23+
> addition to that (such as optionally reading values from environment variables as well)
24+
> should be invisible to the user who wants to simply parse command line arguments.

0 commit comments

Comments
 (0)