diff --git a/credits_generator/README.md b/credits_generator/README.md index 03c187d2d8a..ee89f678174 100644 --- a/credits_generator/README.md +++ b/credits_generator/README.md @@ -3,11 +3,17 @@ credits_generator This tool can be used to update the [Home Assistant's Credits page](https://home-assistant.io/developers/credits/). +Setup +----- + ```bash $ cd credits_generator $ npm install ``` +Usage +----- + Set your personal GitHub access token as environmental variable. ```bash @@ -17,6 +23,7 @@ $ export GITHUB_TOKEN= Run the script. ```bash +$ cd credits_generator $ node update_credits.js ```