Skip to content

Commit 72df192

Browse files
committed
docs: 更新README文件中的安装说明和格式
- 添加通过Eget安装的推荐方法 - 更新Go版本要求至1.22+ - 统一中英文文档格式 - 修复文档中的多余空格
1 parent 3be78be commit 72df192

2 files changed

Lines changed: 30 additions & 10 deletions

File tree

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,31 @@
99

1010
`gitw` - Git command wrapper, generate git changelog, fetch repo information and some git tools.
1111

12-
- Wrap local `git` commands
13-
- Quickly run `git` commands
14-
- Quickly query repository information
12+
- Wrap local `git` commands
13+
- Quickly run `git` commands
14+
- Quickly query repository information
1515
- Quick fetch status, remote, branch ... details
16-
- Quickly generate version changelogs via `git log`
17-
- Allow custom build configuration
18-
- Allow custom build filtering , styles, etc
16+
- Quickly generate version changelogs via `git log`
17+
- Allow custom build configuration
18+
- Allow custom build filtering , styles, etc
1919
- can be used directly in GitHub Actions
2020
- Support git-emoji code search and replace render
2121

2222
> **[中文说明](README.zh-CN.md)**
2323
2424
## Install
2525

26-
> required: go 1.18+, git 2.x
26+
### Install by Eget(Recommended)
27+
28+
> Install by [inherelab/eget](https://github.com/inherelab/eget)
29+
30+
```bash
31+
eget install gookit/gitw
32+
```
33+
34+
### Install by Go
35+
36+
> required: go 1.22+, git 2.x
2737
2838
```bash
2939
go get github.com/gookit/gitw
@@ -190,7 +200,7 @@ Example:
190200
run: |
191201
curl https://github.com/gookit/gitw/releases/latest/download/chlog-linux-amd64 -L -o /usr/local/bin/chlog
192202
chmod a+x /usr/local/bin/chlog
193-
chlog -c .github/changelog.yml -o changelog.md prev last
203+
chlog -c .github/changelog.yml -o changelog.md prev last
194204
195205
```
196206

README.zh-CN.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,17 @@
2525
2626
## 安装
2727

28-
> 需要: go 1.18+, git 2.x
28+
### Install by Eget(Recommended)
29+
30+
> Install by [inherelab/eget](https://github.com/inherelab/eget)
31+
32+
```bash
33+
eget install gookit/gitw
34+
```
35+
36+
### Install by Go
37+
38+
> 需要: go 1.22+, git 2.x
2939
3040
```bash
3141
go get github.com/gookit/gitw
@@ -191,7 +201,7 @@ chlog -c .github/changelog.yml last head
191201
run: |
192202
curl https://github.com/gookit/gitw/releases/latest/download/chlog-linux-amd64 -L -o /usr/local/bin/chlog
193203
chmod a+x /usr/local/bin/chlog
194-
chlog -c .github/changelog.yml -o changelog.md prev last
204+
chlog -c .github/changelog.yml -o changelog.md prev last
195205
196206
```
197207

0 commit comments

Comments
 (0)