You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add more information on OCTOKIT_ACCESS_TOKEN to README.md (#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.
Copy file name to clipboardExpand all lines: api/ruby/find-inactive-members/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ gem install octokit
29
29
30
30
### Configure Octokit
31
31
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.
33
33
34
34
```shell
35
35
export OCTOKIT_ACCESS_TOKEN=00000000000000000000000 # Required if looking for activity in private repositories.
0 commit comments