Skip to content

Commit 6f68a30

Browse files
committed
chore: update deps and update readme docs
1 parent be4cf98 commit 6f68a30

2 files changed

Lines changed: 28 additions & 4 deletions

File tree

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
- Wrap local `git` commands
1313
- Quickly run `git` commands
1414
- Quickly query repository information
15-
- Get remote, branch details
15+
- Quick fetch status, remote, branch ... details
1616
- Quickly generate version changelogs via `git log`
1717
- Allow custom build configuration
1818
- Allow custom build filtering , styles, etc
@@ -90,6 +90,18 @@ You can quickly get a git repository information at local.
9090
repo := gitw.NewRepo("/path/to/my-repo")
9191
```
9292

93+
### Status Information
94+
95+
```go
96+
si := repo.StatusInfo()
97+
98+
dump.Println(si)
99+
```
100+
101+
**Output**:
102+
103+
![repo-status-info](_examples/images/repo-status-info.png)
104+
93105
### Branch Information
94106

95107
```go

README.zh-CN.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@
1111

1212
> Github https://github.com/gookit/gitw
1313
14-
- 包装本地 `git` 命令
15-
- 快速运行 `git` 命令
14+
- 包装本地 `git` 命令以方便使用
15+
- 快速运行 `git` 子命令,获取信息等
1616
- 快速查询存储库信息
17-
- 获取 remote, branch 详细信息
17+
- 获取 status, remote, branch 等详细信息
1818
- 通过 `git log` 快速生成版本变更日志
1919
- 允许自定义生成配置
2020
- 允许自定义生成过滤、样式等
@@ -92,6 +92,18 @@ func main() {
9292
repo := gitw.NewRepo("/path/to/my-repo")
9393
```
9494

95+
### Status 信息
96+
97+
```go
98+
si := repo.StatusInfo()
99+
100+
dump.Println(si)
101+
```
102+
103+
**Output**:
104+
105+
![repo-status-info](_examples/images/repo-status-info.png)
106+
95107
### Branch 信息
96108

97109
```go

0 commit comments

Comments
 (0)