Skip to content

Commit e571b2a

Browse files
committed
docs(readme): update some md style in readme
1 parent 0368684 commit e571b2a

2 files changed

Lines changed: 13 additions & 23 deletions

File tree

README.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,7 @@
1111
A simple and easy-to-use command-line application and tool library written in Golang.
1212
Including running commands, color styles, data display, progress display, interactive methods, etc.
1313

14-
## [中文说明](README.zh-CN.md)
15-
16-
中文说明请看 **[README.zh-CN](README.zh-CN.md)**
17-
18-
## Screenshots
14+
> [中文说明](README.zh-CN.md)
1915
2016
![app-cmd-list](_examples/images/cmd-list.png)
2117

@@ -70,8 +66,7 @@ Rich in functions and easy to use. Highlights grouped by area:
7066

7167
**Extras**
7268

73-
- Color output, interactive input and progress/data display, provided by
74-
[gookit/color](https://github.com/gookit/color) and [gookit/cliui](https://github.com/gookit/cliui)
69+
- Color output, interactive input and progress/data display, provided by [gookit/color](https://github.com/gookit/color) and [gookit/cliui](https://github.com/gookit/cliui)
7570

7671
## GoDoc
7772

@@ -687,8 +682,7 @@ go build ./_examples/cliapp.go && ./cliapp example -h
687682

688683
gcli ships with color output, interactive input (`Confirm` / `Select` / `ReadLine` ...),
689684
progress display (`Bar` / `Spinner` / `Loading` ...) and data display (table / list / tree),
690-
provided by [gookit/color](https://github.com/gookit/color) and
691-
[gookit/cliui](https://github.com/gookit/cliui).
685+
provided by [gookit/color](https://github.com/gookit/color) and [gookit/cliui](https://github.com/gookit/cliui).
692686

693687
```go
694688
color.Info.Tips("processing...") // colored output
@@ -699,7 +693,9 @@ if !ok {
699693
}
700694

701695
p := progress.Bar(100) // progress bar
702-
p.Start(); /* p.Advance() in loop */ p.Finish()
696+
p.Start();
697+
/* p.Advance() in loop */
698+
p.Finish()
703699
```
704700

705701
> For more usage see [gookit/color](https://github.com/gookit/color) and [gookit/cliui](https://github.com/gookit/cliui).
@@ -710,7 +706,6 @@ p.Start(); /* p.Advance() in loop */ p.Finish()
710706
- [gookit/rux](https://github.com/gookit/rux) Simple and fast request router for golang HTTP
711707
- [gookit/gcli](https://github.com/gookit/gcli) build CLI application, tool library, running CLI commands
712708
- [gookit/event](https://github.com/gookit/event) Lightweight event manager and dispatcher implements by Go
713-
- [gookit/cache](https://github.com/gookit/cache) Generic cache use and cache manager for golang. support File, Memory, Redis, Memcached.
714709
- [gookit/config](https://github.com/gookit/config) Go config management. support JSON, YAML, TOML, INI, HCL, ENV and Flags
715710
- [gookit/color](https://github.com/gookit/color) A command-line color library with true color support, universal API methods and Windows support
716711
- [gookit/filter](https://github.com/gookit/filter) Provide filtering, sanitizing, and conversion of golang data

README.zh-CN.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,9 @@
88
[![Go Report Card](https://goreportcard.com/badge/github.com/gookit/gcli)](https://goreportcard.com/report/github.com/gookit/gcli)
99
[![Coverage Status](https://coveralls.io/repos/github/gookit/gcli/badge.svg?branch=master)](https://coveralls.io/github/gookit/gcli?branch=master)
1010

11-
Golang编写的简单易用的命令行应用,工具库。包含运行命令,颜色风格,数据展示,进度显示,交互方法等
11+
Golang 编写的简单易用的命令行应用,工具库。包含运行命令,颜色风格,数据展示,进度显示,交互方法等
1212

13-
## [ENGLISH](README.md)
14-
15-
The english introduction please ses **[README](README.md)**
16-
17-
## 截图展示
13+
> [EN RAEDME](README.md)
1814
1915
![app-cmd-list](_examples/images/cmd-list.png)
2016

@@ -69,8 +65,7 @@ The english introduction please ses **[README](README.md)**
6965

7066
**周边**
7167

72-
- 颜色输出、交互输入、进度与数据展示,分别由
73-
[gookit/color](https://github.com/gookit/color)[gookit/cliui](https://github.com/gookit/cliui) 提供
68+
- 颜色输出、交互输入、进度与数据展示,分别由 [gookit/color](https://github.com/gookit/color)[gookit/cliui](https://github.com/gookit/cliui) 提供
7469

7570
## GoDoc
7671

@@ -649,8 +644,7 @@ var MyCommand = &gcli.Command{
649644

650645
gcli 内置了颜色输出、交互输入(`Confirm` / `Select` / `ReadLine` 等)、
651646
进度显示(`Bar` / `Spinner` / `Loading` 等)以及数据展示(表格 / 列表 / 树),
652-
分别由 [gookit/color](https://github.com/gookit/color)
653-
[gookit/cliui](https://github.com/gookit/cliui) 提供。
647+
分别由 [gookit/color](https://github.com/gookit/color)[gookit/cliui](https://github.com/gookit/cliui) 提供。
654648

655649
```go
656650
color.Info.Tips("processing...") // 颜色输出
@@ -661,7 +655,9 @@ if !ok {
661655
}
662656

663657
p := progress.Bar(100) // 进度条
664-
p.Start(); /* 循环中 p.Advance() */ p.Finish()
658+
p.Start();
659+
/* 循环中 p.Advance() */
660+
p.Finish()
665661
```
666662

667663
> 更多用法详见 [gookit/color](https://github.com/gookit/color)[gookit/cliui](https://github.com/gookit/cliui)
@@ -672,7 +668,6 @@ p.Start(); /* 循环中 p.Advance() */ p.Finish()
672668
- [gookit/rux](https://github.com/gookit/rux) Simple and fast request router for golang HTTP
673669
- [gookit/gcli](https://github.com/gookit/gcli) Go的命令行应用,工具库,运行CLI命令,支持命令行色彩,用户交互,进度显示,数据格式化显示
674670
- [gookit/event](https://github.com/gookit/event) Go实现的轻量级的事件管理、调度程序库, 支持设置监听器的优先级, 支持对一组事件进行监听
675-
- [gookit/cache](https://github.com/gookit/cache) 通用的缓存使用包装库,通过包装各种常用的驱动,来提供统一的使用API
676671
- [gookit/config](https://github.com/gookit/config) Go应用配置管理,支持多种格式(JSON, YAML, TOML, INI, HCL, ENV, Flags),多文件加载,远程文件加载,数据合并
677672
- [gookit/color](https://github.com/gookit/color) CLI 控制台颜色渲染工具库, 拥有简洁的使用API,支持16色,256色,RGB色彩渲染输出
678673
- [gookit/filter](https://github.com/gookit/filter) 提供对Golang数据的过滤,净化,转换

0 commit comments

Comments
 (0)