Skip to content

Commit d08243c

Browse files
authored
Add more information on OCTOKIT_ACCESS_TOKEN to README.md (github#261)
This tool can send a relatively large number of API requests. If not authenticated, the tool may not be able to complete even a single run. Add information about why this happens, and give the user information about how to generate the token.
1 parent 459f28b commit d08243c

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

api/ruby/find-inactive-members/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ gem install octokit
2929

3030
### Configure Octokit
3131

32-
The `OCTOKIT_ACCESS_TOKEN` is required in order to see activities on private repositories. However the `OCTOKIT_API_ENDPOINT` isn't required if connecting to GitHub.com, but is required if connecting to a GitHub Enterprise instance.
32+
The `OCTOKIT_ACCESS_TOKEN` is required in order to see activities on private repositories. Also note that GitHub.com has an rate limit of 60 unauthenticated requests per hour, which this tool can easily exceed. Access tokens can be generated at https://github.com/settings/tokens. The `OCTOKIT_API_ENDPOINT` isn't required if connecting to GitHub.com, but is required if connecting to a GitHub Enterprise instance.
3333

3434
```shell
3535
export OCTOKIT_ACCESS_TOKEN=00000000000000000000000 # Required if looking for activity in private repositories.

0 commit comments

Comments
 (0)