Skip to content

Commit c2e1712

Browse files
authored
Merge pull request #13 from jonchurch/pat-docs-update
docs: make github PAT info more prominent
2 parents 4cf5391 + 7edd0d5 commit c2e1712

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,13 @@ GitHub forks, stars or watchers
55

66
This repository is managed by the [Package Maintenance Working Group](https://github.com/nodejs/package-maintenance), see [Governance](https://github.com/nodejs/package-maintenance/blob/master/Governance.md).
77

8+
### Personal Access Token
9+
10+
Note that to use this tool you need a GitHub personal token set as an
11+
environment variable named `GITHUB_TOKEN`. For public repositories, no scopes are required. For more information about GitHub
12+
tokens:
13+
<https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line>
14+
815
### Install
916

1017
To install this tool run:
@@ -16,7 +23,7 @@ $ npm i -g dependents
1623
Or via npx:
1724

1825
```sh
19-
$ npx dependents [options]
26+
$ GITHUB_TOKEN=<your token> npx dependents [options]
2027
```
2128

2229
### Require it in your project
@@ -92,7 +99,3 @@ dependents --package express --number 5 --sort downloads --total 25 --json
9299
]
93100
```
94101

95-
Note that to use this tool you need a GitHub personal token set as an
96-
environment variable named GITHUB_TOKEN. For more information about GitHub
97-
tokens:
98-
<https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line>

0 commit comments

Comments
 (0)