mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-14 12:56:54 +00:00
Add README for the generator
This commit is contained in:
parent
1b417fa2ba
commit
d6c71bdb97
29
credits_generator/README.md
Normal file
29
credits_generator/README.md
Normal 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
|
||||
```
|
||||
|
Loading…
x
Reference in New Issue
Block a user