Skip to content

Commit 5344673

Browse files
committed
docs: remove rate limit documentation for now
Remove the `FETCH_SINGLE_PAGE_STARS` from documentation for now since it might confuse people.
1 parent deb38e6 commit 5344673

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

Diff for: readme.md

+9-11
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,6 @@ Visit <https://indiafightscorona.giveindia.org> and make a small donation to hel
8080

8181
# Features
8282

83-
- [Important Notice](#important-notice)
8483
- [GitHub Stats Card](#github-stats-card)
8584
- [GitHub Extra Pins](#github-extra-pins)
8685
- [Top Languages Card](#top-languages-card)
@@ -94,12 +93,7 @@ Visit <https://indiafightscorona.giveindia.org> and make a small donation to hel
9493
- [Language Card Exclusive Options](#language-card-exclusive-options)
9594
- [Wakatime Card Exclusive Option](#wakatime-card-exclusive-options)
9695
- [Deploy Yourself](#deploy-on-your-own-vercel-instance)
97-
- [Disable rate limit protections](#disable-rate-limit-protections)
98-
99-
# Important Notice
100-
101-
> **Warning**
102-
> Since the GitHub API only [allows 5k requests per hour per user account](https://docs.github.com/en/graphql/overview/resource-limitations), the public Vercel instance hosted on `https://github-readme-stats.vercel.app/api` could possibly hit the rate limiter (see #1471). Because of this, we have limited the public API to only fetch the first 100 repositories with stars and languages. As a result, for a very active GitHub account, the language, stars and commits results might be off when using the public API. You can disable these rate limit protections by deploying [your own Vercel instance](#deploy-on-your-own-vercel-instance), so in that case, you will have more accurate results and do not have to worry about downtime! :rocket:
96+
- [Keep your fork up to date](#keep-your-fork-up-to-date)
10397

10498
# GitHub Stats Card
10599

@@ -359,7 +353,7 @@ Use [show_owner](#customization) variable to include the repo's owner username
359353
The top languages card shows a GitHub user's most frequently used top language.
360354

361355
> **Note**
362-
> Top Languages does not indicate my skill level or anything like that; it's a GitHub metric to determine which languages have the most code on GitHub. It is a new feature of github-readme-stats.\_
356+
> Top Languages does not indicate my skill level or anything like that; it's a GitHub metric to determine which languages have the most code on GitHub. It is a new feature of github-readme-stats.
363357
364358
### Usage
365359

@@ -503,13 +497,17 @@ By default, GitHub does not lay out the cards side by side. To do that, you can
503497

504498
## Deploy on your own Vercel instance
505499

506-
As explained [above](#important-notice), the GitHub API only [allows 5k requests per hour per user account](https://docs.github.com/en/graphql/overview/resource-limitations), the public Vercel instance hosted on `https://github-readme-stats.vercel.app/api` could possibly hit the rate limiter (see #1471). Because of this, we have limited the public API to only fetch the first 100 repositories with stars and languages. As a result, for a very active GitHub account, the language, stars and commits results might be off when using the public API. You can disable these [rate limit protections](#disable-rate-limit-protections) using Vercel environment variables when you deploy [your own Vercel instance](#deploy-on-your-own-vercel-instance), so in that case, you will have more accurate results and do not have to worry about downtime! Click on [the deploy button](https://vercel.com/import/project?template=https://github.com/anuraghazra/github-readme-stats) and follow the video or step-to-step guides below to get started! :rocket:
507-
508-
[![Deploy to Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/anuraghazra/github-readme-stats)
500+
#### [Check Out Step By Step Video Tutorial By @codeSTACKr](https://youtu.be/n6d4KHSKqGk?t=107)
509501

510502
> **Warning**
511503
> If you are on the [hobby (i.e. free)](https://vercel.com/pricing) Vercel plan, please make sure you change the `maxDuration` parameter in the [vercel.json](https://github.com/anuraghazra/github-readme-stats/blob/master/vercel.json) file from `30` to `10` (see [#1416](https://github.com/anuraghazra/github-readme-stats/issues/1416#issuecomment-950275476) for more information).
512504
505+
Since the GitHub API only allows 5k requests per hour, my `https://github-readme-stats.vercel.app/api` could possibly hit the rate limiter. If you host it on your own Vercel server, then you do not have to worry about anything. Click on the deploy button to get started!
506+
507+
> **Note**
508+
> Since [#58](https://github.com/anuraghazra/github-readme-stats/pull/58), we should be able to handle more than 5k requests and have fewer issues with downtime :grin:.
509+
[![Deploy to Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/anuraghazra/github-readme-stats)
510+
513511
#### :film_projector: [Check Out Step By Step Video Tutorial By @codeSTACKr](https://youtu.be/n6d4KHSKqGk?t=107)
514512

515513
<details>

0 commit comments

Comments
 (0)