Skip to content

Commit

Permalink
chore: update some sub pkg README docs
Browse files Browse the repository at this point in the history
  • Loading branch information
inhere committed Oct 16, 2022
1 parent 78f08ea commit 8684f86
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 14 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,7 @@ Including running commands, color styles, data display, progress display, intera

## GoDoc

- [godoc for gopkg](https://pkg.go.dev/gopkg.in/gookit/gcli.v2)
- [godoc for github](https://pkg.go.dev/github.com/gookit/gcli/v3)
- [godoc](https://pkg.go.dev/github.com/gookit/gcli/v3)

## Install

Expand Down
3 changes: 1 addition & 2 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,7 @@ The english introduction please ses **[README](README.md)**

## GoDoc

- [godoc for gopkg](https://pkg.go.dev/gopkg.in/gookit/gcli.v2)
- [godoc for github](https://pkg.go.dev/github.com/gookit/gcli/v3)
- [godoc](https://pkg.go.dev/github.com/gookit/gcli/v3)

## 安装

Expand Down
22 changes: 17 additions & 5 deletions gflag/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,44 @@

## GoDoc

Please see https://pkg.go.dev/github.com/gookit/gcli/v2/gflag
Please see https://pkg.go.dev/github.com/gookit/gcli/v3/gflag

## Install

```shell
go get github.com/gookit/gcli/v2/gflag
go get github.com/gookit/gcli/v3/gflag
```

## Usage

```go
```go file="demo.go"
package main

import (
"fmt"
"os"

"github.com/gookit/gcli/v2/gflag"
"github.com/gookit/gcli/v3/gflag"
"github.com/gookit/goutil"
)

var name string

func main() {
gf := gflag.New("testFlags")
gf.StrOpt(&name, "name", "n", "", "")

gf.SetHandle(func(p *gflag.Parser) error {
fmt.Println(p.Name())
return nil
})

gf.Parse()
goutil.MustOK(gf.Parse(os.Args[1:]))
}
```

### Run

```shell
go run demo.go
```
4 changes: 2 additions & 2 deletions interact/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ command-line interactive util methods

## GoDoc

Please see https://pkg.go.dev/github.com/gookit/gcli/v2/interact
Please see https://pkg.go.dev/github.com/gookit/gcli/v3/interact

## Install

```shell
go get github.com/gookit/gcli/v2/interact
go get github.com/gookit/gcli/v3/interact
```

## Select & Choice
Expand Down
2 changes: 1 addition & 1 deletion progress/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Package progress provide terminal progress bar display. Such as: `Txt`, `Bar`, `

## GoDoc

Please see https://pkg.go.dev/github.com/gookit/gcli/v2/progress
Please see https://pkg.go.dev/github.com/gookit/gcli/v3/progress

## Install

Expand Down
4 changes: 2 additions & 2 deletions show/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ contains `section, panel, padding, helpPanel, table, tree, title, list, multiLis

## GoDoc

Please see https://pkg.go.dev/github.com/gookit/gcli/v2/show
Please see https://pkg.go.dev/github.com/gookit/gcli/v3/show

## Install

```shell
go get github.com/gookit/gcli/v2/show
go get github.com/gookit/gcli/v3/show
```

## Related
Expand Down

0 comments on commit 8684f86

Please sign in to comment.