enhance document

Songmu · Mar 11, 2017 · 9027d49 · 9027d49
1 parent fffff81
commit 9027d49
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -37,12 +37,24 @@ Generate changelog from git history, tags and merged pull requests
     --remote=       default remote name (default: origin)
 ```
 
+## GITHUB Token
+
+When github's api token is required in private repository etc., it is used in the following order of priority.
+
+- command line option `--token`
+- enviroment variable `GITHUB_TOKEN`
+- `git config github.token`
+
 ## GitHub Enterprise
 
 You can use `ghch` for GitHub Enterprise. Change API endpoint via the enviromental variable.
 
     $ export GITHUB_API=http://github.company.com/api/v3
 
+## Requirements
+
+git 1.8.5 or newer is required.
+
 ## Examples
 
 ### display changes from last versioned tag