jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md for credits_generator (#5065)

Browse Source
This commit is contained in:
Albert Lee 2018-03-31 06:09:15 -05:00 committed by Fabian Affolter
parent 0bdaf10a38
commit 17bae0c271
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
credits_generator/README.md
View File

@ -1,11 +1,12 @@
credits_generator
=================
This tool can be used to update the [Home Assistant's Credits page](https://home-assistant.io/developers/credits/).
This tool can be used to update the [Credits page for Home Assistant](https://home-assistant.io/developers/credits/).
Setup
-----
Fetch the dependencies with `npm`.
```bash
$ cd credits_generator
$ npm install
@ -13,8 +14,11 @@ $ npm install
Usage
-----
Go to https://github.com/settings/tokens/new and generate a new GitHub personal access token.
Give the token any name and select the `public_repo` and `read:user` scopes.
Set your personal GitHub access token as environmental variable.
Set the environment variable `GITHUB_TOKEN` to the new token.
```bash
$ export GITHUB_TOKEN=<Your GitHub access token>
@ -23,7 +27,6 @@ $ export GITHUB_TOKEN=<Your GitHub access token>
Run the script.
```bash
$ cd credits_generator
$ node update_credits.js
```