Skip to content

Commit d6c71bd

Browse files
committed
Add README for the generator
1 parent 1b417fa commit d6c71bd

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

credits_generator/README.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
credits_generator
2+
=================
3+
4+
This tool can be used to update the [Home Assistant's Credits page](https://home-assistant.io/developers/credits/).
5+
6+
```bash
7+
$ cd credits_generator
8+
$ npm install
9+
```
10+
11+
Set your personal GitHub access token as environmental variable.
12+
13+
```bash
14+
$ export GITHUB_TOKEN=<Your GitHub access token>
15+
```
16+
17+
Run the script.
18+
19+
```bash
20+
$ node update_credits.js
21+
```
22+
23+
Commit the changes (depending on our setup).
24+
25+
```bash
26+
$ git commit ../source/developers/credits.markdown
27+
$ git push upstream
28+
```
29+

0 commit comments

Comments
 (0)