jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/credits_generator
History
Albert Lee 17bae0c271 Update README.md for credits_generator (#5065)
2018-03-31 13:09:15 +02:00
..
credits.mustache Add Governance blog post, docs, update footer with Creative Commons license, add credits_generator 2017-01-22 16:56:49 -08:00
package.json Update license to be in sync with the ha org 2017-04-19 07:49:49 +02:00
README.md Update README.md for credits_generator (#5065) 2018-03-31 13:09:15 +02:00
update_credits.js Escape special characters in credits (#5064) 2018-03-31 11:08:15 +02:00

README.md

credits_generator

This tool can be used to update the Credits page for Home Assistant.

Setup

Fetch the dependencies with npm.

$ cd credits_generator
$ 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 the environment variable GITHUB_TOKEN to the new token.

$ export GITHUB_TOKEN=<Your GitHub access token>

Run the script.

$ node update_credits.js

Commit the changes (depending on our setup).

$ git commit ../source/developers/credits.markdown
$ git push upstream