Skip to content

Commit 8684f86

Browse files
committed
chore: update some sub pkg README docs
1 parent 78f08ea commit 8684f86

File tree

6 files changed

+24
-14
lines changed

6 files changed

+24
-14
lines changed

README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,7 @@ Including running commands, color styles, data display, progress display, intera
5858

5959
## GoDoc
6060

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

6463
## Install
6564

README.zh-CN.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,7 @@ The english introduction please ses **[README](README.md)**
4444

4545
## GoDoc
4646

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

5049
## 安装
5150

gflag/README.md

+17-5
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,44 @@
44

55
## GoDoc
66

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

99
## Install
1010

1111
```shell
12-
go get github.com/gookit/gcli/v2/gflag
12+
go get github.com/gookit/gcli/v3/gflag
1313
```
1414

1515
## Usage
1616

17-
```go
17+
```go file="demo.go"
1818
package main
1919

2020
import (
2121
"fmt"
22+
"os"
2223

23-
"github.com/gookit/gcli/v2/gflag"
24+
"github.com/gookit/gcli/v3/gflag"
25+
"github.com/gookit/goutil"
2426
)
2527

28+
var name string
29+
2630
func main() {
2731
gf := gflag.New("testFlags")
32+
gf.StrOpt(&name, "name", "n", "", "")
33+
2834
gf.SetHandle(func(p *gflag.Parser) error {
2935
fmt.Println(p.Name())
3036
return nil
3137
})
3238

33-
gf.Parse()
39+
goutil.MustOK(gf.Parse(os.Args[1:]))
3440
}
3541
```
42+
43+
### Run
44+
45+
```shell
46+
go run demo.go
47+
```

interact/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ command-line interactive util methods
1414

1515
## GoDoc
1616

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

1919
## Install
2020

2121
```shell
22-
go get github.com/gookit/gcli/v2/interact
22+
go get github.com/gookit/gcli/v3/interact
2323
```
2424

2525
## Select & Choice

progress/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Package progress provide terminal progress bar display. Such as: `Txt`, `Bar`, `
1010

1111
## GoDoc
1212

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

1515
## Install
1616

show/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ contains `section, panel, padding, helpPanel, table, tree, title, list, multiLis
1616

1717
## GoDoc
1818

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

2121
## Install
2222

2323
```shell
24-
go get github.com/gookit/gcli/v2/show
24+
go get github.com/gookit/gcli/v3/show
2525
```
2626

2727
## Related

0 commit comments

Comments
 (0)