Browse Source

udpate readme

Alex Flint 10 years ago
parent
commit
b666b30474
1 changed files with 7 additions and 5 deletions
  1. +7
    -5
      README.md

+ 7
- 5
README.md View File

@ -1,9 +1,5 @@
## Structured argument parsing for Go ## Structured argument parsing for Go
```shell
go get github.com/alexflint/go-arg
```
```go ```go
var args struct { var args struct {
Foo string Foo string
@ -29,7 +25,7 @@ args.Foo = "default value"
arg.MustParse(&args) arg.MustParse(&args)
``` ```
### Marking options as required
### Required options
```go ```go
var args struct { var args struct {
@ -100,6 +96,12 @@ fmt.Printf("Fetching the following IDs from %s: %q", args.Database, args.IDs)
Fetching the following IDs from foo: [1 2 3] Fetching the following IDs from foo: [1 2 3]
``` ```
### Installation
```shell
go get github.com/alexflint/go-arg
```
### Rationale ### Rationale
There are many command line argument parsing libraries for Go, including one in the standard library, so why build another? There are many command line argument parsing libraries for Go, including one in the standard library, so why build another?


Loading…
Cancel
Save