@@ -38,6 +38,12 @@ See the [types](./types/index.d.ts) for details.
3838
3939#### ` Author.commitCount ` : number
4040
41+ ### Branches
42+
43+ #### branches.local: string[ ]
44+
45+ #### branches.remote: Record<string, string[ ] >
46+
4147### Commit
4248
4349#### ` Commit.author ` : [ Pick<Author, 'email' | 'name'>] ( #Author )
@@ -62,8 +68,12 @@ Type of `Remote` is `Record<string, { fetch: string, push: string }>`. `Record`
6268
6369#### ` Remote.origin.fetch ` : string
6470
71+ ` origin ` is remoteName. It depends on your settings.
72+
6573#### ` Remote.origin.push ` : string
6674
75+ ` origin ` is remoteName. It depends on your settings.
76+
6777## Functions
6878
6979See the [ types] ( ./types/index.d.ts ) for details.
@@ -88,9 +98,25 @@ filtering logs with branchName. default is `'HEAD'`.
8898
8999* [ Author] ( #Author )
90100
91- ### [ WIP] branches()
101+ ### branches()
102+
103+ Get branch info with ` git branch ` command.
104+
105+ #### Since
106+
107+ 0.3.0
108+
109+ #### Arguments
110+
111+ * withRemote
112+
113+ ##### withRemote: boolean
114+
115+ To get remote info, set it ` true ` . default is ` true ` .
116+
117+ #### Returns
92118
93- Get branch info.
119+ * [ Branches ] ( #Branches )
94120
95121### commits()
96122
@@ -106,15 +132,15 @@ Get commit info with `git log` command.
106132
107133##### ` logOption.count ` : number
108134
109- how many log to get. default is ` 1000 ` . ` 0 ` is no limit.
135+ How many log to get. default is ` 1000 ` . ` 0 ` is no limit.
110136
111137##### ` logOption.withFile ` : boolean
112138
113- whether to get file name. default is ` false ` .
139+ Whether to get file name. default is ` false ` .
114140
115141##### ` logOption.branch ` : string
116142
117- filtering logs with branch name. default is ` '' ` .
143+ Filtering logs with branch name. default is ` '' ` .
118144
119145#### Returns
120146
0 commit comments