Merge pull request #13 from tkskto/fix/update-version

Fix/update version

Author: tkskto

README.md

@@ -38,6 +38,12 @@ See the [types](./types/index.d.ts) for details.
 
 #### `Author.commitCount`: number
 
+### Branches
+
+#### branches.local: string[]
+
+#### branches.remote: Record<string, string[]>
+
 ### Commit
 
 #### `Commit.author`: [Pick<Author, 'email' | 'name'>](#Author)
@@ -62,8 +68,12 @@ Type of `Remote` is `Record<string, { fetch: string, push: string }>`. `Record`
 
 #### `Remote.origin.fetch`: string
 
+`origin` is remoteName. It depends on your settings.
+
 #### `Remote.origin.push`: string
 
+`origin` is remoteName. It depends on your settings.
+
 ## Functions
 
 See the [types](./types/index.d.ts) for details.
@@ -88,9 +98,25 @@ filtering logs with branchName. default is `'HEAD'`.
 
 *   [Author](#Author)
 
-### [WIP] branches()
+### branches()
+
+Get branch info with `git branch` command.
+
+#### Since
+
+0.3.0
+
+#### Arguments
+
+* withRemote
+
+##### withRemote: boolean
+
+To get remote info, set it `true`. default is `true`.
+
+#### Returns
 
-Get branch info.
+*   [Branches](#Branches)
 
 ### commits()
 
@@ -106,15 +132,15 @@ Get commit info with `git log` command.
 
 ##### `logOption.count`: number
 
-how many log to get. default is `1000`. `0` is no limit.
+How many log to get. default is `1000`. `0` is no limit.
 
 ##### `logOption.withFile`: boolean
 
-whether to get file name. default is `false`.
+Whether to get file name. default is `false`.
 
 ##### `logOption.branch`: string
 
-filtering logs with branch name. default is `''`.
+Filtering logs with branch name. default is `''`.
 
 #### Returns
 

__tests__/spec/branches.ts

@@ -10,10 +10,9 @@ describe('branch test', () => {
       expect(branch.local.length).toStrictEqual(1);
       expect(branch.remote).toBeUndefined();
     } else {
+      // TODO: it must be failed.
       expect(branch).toStrictEqual({
         local: [
-          'feature/add-branches',
-          'feature/add-remote-details',
           'main'
         ],
       });
@@ -30,14 +29,13 @@ describe('branch test', () => {
         expect(branch.remote.pull.length).toStrictEqual(1);
       }
     } else {
+      // TODO: it must be failed.
       expect(branch).toStrictEqual({
         local: [
-          'feature/add-branches',
-          'feature/add-remote-details',
           'main'
         ],
         remote: {
-          origin: [ 'feature/add-branches', 'main' ],
+          origin: [ 'main' ],
         },
       });
     }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "git-log-nodejs",
-  "version": "0.1.1",
+  "version": "0.3.1",
   "description": "git-log-nodejs is a tool to get git logs.",
   "main": "dist/index.js",
   "types": "types/index.d.ts",