Skip to content

Commit

Permalink
chore: update deps and update readme docs
Browse files Browse the repository at this point in the history
  • Loading branch information
inhere committed Oct 29, 2022
1 parent be4cf98 commit 6f68a30
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 4 deletions.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
- Wrap local `git` commands
- Quickly run `git` commands
- Quickly query repository information
- Get remote, branch details
- Quick fetch status, remote, branch ... details
- Quickly generate version changelogs via `git log`
- Allow custom build configuration
- Allow custom build filtering , styles, etc
Expand Down Expand Up @@ -90,6 +90,18 @@ You can quickly get a git repository information at local.
repo := gitw.NewRepo("/path/to/my-repo")
```

### Status Information

```go
si := repo.StatusInfo()

dump.Println(si)
```

**Output**:

![repo-status-info](_examples/images/repo-status-info.png)

### Branch Information

```go
Expand Down
18 changes: 15 additions & 3 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@

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

### Status 信息

```go
si := repo.StatusInfo()

dump.Println(si)
```

**Output**:

![repo-status-info](_examples/images/repo-status-info.png)

### Branch 信息

```go
Expand Down

0 comments on commit 6f68a30

Please sign in to comment.