chore: update readme add branch info doces

gookit · Jun 29, 2022 · 3c08adf · 3c08adf
1 parent 691f8a4
commit 3c08adf
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -87,25 +87,37 @@ You can quickly get a git repository information at local.
 repo := gitw.NewRepo("/path/to/my-repo")
 ```
 
-**Remote Information**:
+### Branch Information
+
+```go
+brInfo := repo.CurBranchInfo()
+
+dump.Println(brInfo)
+```
+
+**Output**:
+
+![one-remote-info](_examples/images/one-branch-info.png)
+
+### Remote Information
 
 ```go
 rt := repo.DefaultRemoteInfo()
 
 dump.Println(rt)
 ```
 
-Output:
+**Output**:
 
 ![one-remote-info](_examples/images/one-remote-info.png)
 
-**Repo Information**:
+### Repo Information
 
 ```go
 dump.Println(repo.Info())
 ```
 
-Output:
+**Output**:
 
 ![simple-repo-info](_examples/images/simple-repo-info.png)
 

diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -89,15 +89,27 @@ func main() {
 repo := gitw.NewRepo("/path/to/my-repo")
 ```
 
-**Remote 信息**:
+### Branch 信息
+
+```go
+brInfo := repo.CurBranchInfo()
+
+dump.Println(brInfo)
+```
+
+**Output**:
+
+![one-remote-info](_examples/images/one-branch-info.png)
+
+### Remote 信息
 
 ```go
 rt := repo.DefaultRemoteInfo()
 
 dump.Println(rt)
 ```
 
-Output:
+**Output**:
 
 ![one-remote-info](_examples/images/one-remote-info.png)
 
@@ -107,7 +119,7 @@ Output:
 dump.Println(repo.Info())
 ```
 
-Output:
+**Output**:
 
 ![simple-repo-info](_examples/images/simple-repo-info.png)
 

diff --git a/_examples/images/one-branch-info.png b/_examples/images/one-branch-info.png