status-im
/
burnchart
mirror of https://github.com/status-im/burnchart.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README.md to include api_token for private repo support

This commit is contained in:
Eric Bollens 2013-07-10 18:48:55 -07:00
parent af47ff3f65
commit 3ca474502a
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -19,7 +19,7 @@ $ npm install -d
## Configure: ## Configure:
The app is configured by pointing to a public GitHub user/project. Do so in `config.yml`: The app is configured by pointing to a GitHub user/project. Do so in `config.yml`:
```yaml ```yaml
github_user: 'intermine' github_user: 'intermine'
@ -29,6 +29,14 @@ project_name: 'Core InterMine Project'
The `project_name` key-value pair represents the title of the burndown chart that you will see in the top right corner of the page. The `project_name` key-value pair represents the title of the burndown chart that you will see in the top right corner of the page.
To configure the app for a private GitHub project, you must additionally set the `api_token` key-value pair in `config.yml`:
```yaml
api_token: '5baa61e4c9b93f3f0682250b6cf8331b7ee68fd8'
```
To generate an access token, see your [GitHub Application Settings](https://github.com/settings/applications).
### Milestones ### Milestones
Then visit your GitHub project's Issues page and create a new milestone with a date due in the future. This will represent your iteration. This app will pick the Milestone with the **closest due date in the future** as the *current* one. Then visit your GitHub project's Issues page and create a new milestone with a date due in the future. This will represent your iteration. This app will pick the Milestone with the **closest due date in the future** as the *current* one.