Skip to content

Commit 17bae0c

Browse files
triskfabaff
authored andcommitted
Update README.md for credits_generator (home-assistant#5065)
1 parent 0bdaf10 commit 17bae0c

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

credits_generator/README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
11
credits_generator
22
=================
33

4-
This tool can be used to update the [Home Assistant's Credits page](https://home-assistant.io/developers/credits/).
4+
This tool can be used to update the [Credits page for Home Assistant](https://home-assistant.io/developers/credits/).
55

66
Setup
77
-----
88

9+
Fetch the dependencies with `npm`.
910
```bash
1011
$ cd credits_generator
1112
$ npm install
1213
```
1314

1415
Usage
1516
-----
17+
Go to https://github.com/settings/tokens/new and generate a new GitHub personal access token.
18+
Give the token any name and select the `public_repo` and `read:user` scopes.
1619

17-
Set your personal GitHub access token as environmental variable.
20+
21+
Set the environment variable `GITHUB_TOKEN` to the new token.
1822

1923
```bash
2024
$ export GITHUB_TOKEN=<Your GitHub access token>
@@ -23,7 +27,6 @@ $ export GITHUB_TOKEN=<Your GitHub access token>
2327
Run the script.
2428

2529
```bash
26-
$ cd credits_generator
2730
$ node update_credits.js
2831
```
2932

0 commit comments

Comments
 (0)