Add README for the generator

This commit is contained in:
Fabian Affolter 2017-04-19 07:51:09 +02:00
parent 1b417fa2ba
commit d6c71bdb97
No known key found for this signature in database
GPG Key ID: DDF3D6F44AAB1336

View File

@ -0,0 +1,29 @@
credits_generator
=================
This tool can be used to update the [Home Assistant's Credits page](https://home-assistant.io/developers/credits/).
```bash
$ cd credits_generator
$ npm install
```
Set your personal GitHub access token as environmental variable.
```bash
$ export GITHUB_TOKEN=<Your GitHub access token>
```
Run the script.
```bash
$ node update_credits.js
```
Commit the changes (depending on our setup).
```bash
$ git commit ../source/developers/credits.markdown
$ git push upstream
```