diff --git a/credits_generator/README.md b/credits_generator/README.md index ee89f678174..986f0b47859 100644 --- a/credits_generator/README.md +++ b/credits_generator/README.md @@ -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= @@ -23,7 +27,6 @@ $ export GITHUB_TOKEN= Run the script. ```bash -$ cd credits_generator $ node update_credits.js ```