Merge pull request #22 from MatthiesenXYZ/issue-15-Exceeding_the_octokit_quota_results_in_a_broken_page

Update README.md
This commit is contained in:
Adam Matthiesen 2024-03-04 21:32:24 -08:00 committed by GitHub
commit 69bf45d672
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 1 deletions

View File

@ -76,7 +76,9 @@ Github Personal Access Token (Classic)
GITHUB_PERSONAL_TOKEN=ghp_YOURPERSONALTOKENHERE
```
*Note: Without this token, you will be HEAVILY limited by quantity of requests made with Octokit.*
*Note: Without this token, you will be HEAVILY limited by quantity of requests made with Octokit. (Unauthorized Octokit Instances are limited to 60 requests per hour)*
*Note: It is recommended to use this Integration in SSG(Static Site) mode only(or enable prerendering for pages with Gists), as in SSR(Server Rendered) mode that could overload your Octokit request limit quite fast. Keep in mind for each Gist/Gists request made that counts twords your global limit.(60 requests per hour for unauthorized Octokit, 5,000 requests per hour for personal access tokens, and if using a GitHub App by Under GitHub Enterprise Cloud is 15,000+) see [GitHub Docs](https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api?apiVersion=2022-11-28#primary-rate-limit-for-authenticated-users)*
### Usage