From 44c268e05ad6b9eb572810a2d71f043900d4cd2e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=81=97=E3=81=90=E3=82=8C?= <23041178+ForsakenRei@users.noreply.github.com> Date: Fri, 9 Jun 2023 03:06:45 -0400 Subject: [PATCH] Update readme.md about maxDuration (#2792) * Update readme.md about maxDuration I think we can remove this warning section since that value in `.json` has been changed to 10 by default nowadays? * Update readme.md remove related section in self deployment section as well * docs: add inverse maxDuration warning --------- Co-authored-by: rickstaa --- readme.md | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/readme.md b/readme.md index 8ac68ab5ce44e..f4d0ecfcbf92d 100644 --- a/readme.md +++ b/readme.md @@ -596,14 +596,14 @@ By default, GitHub does not lay out the cards side by side. To do that, you can #### :film_projector: [Check Out Step By Step Video Tutorial By @codeSTACKr](https://youtu.be/n6d4KHSKqGk?t=107) -> **Warning** -> 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). - 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! > **Note** > 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:. +> **Note** +> If you are on the [Pro (i.e. paid)](https://vercel.com/pricing) Vercel plan, the [maxDuration](https://vercel.com/docs/concepts/projects/project-configuration#value-definition) value found in the [Vercel.json](https://github.com/anuraghazra/github-readme-stats/blob/master/vercel.json) can be increased when your Vercel instance frequently times out during the card request. You are advised to keep this value lower than `30` seconds to prevent high memory usage. + [![Deploy to Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/anuraghazra/github-readme-stats)
@@ -616,16 +616,15 @@ Since the GitHub API only allows 5k requests per hour, my `https://github-readme ![](https://files.catbox.moe/b9oxey.png) 4. Sign in to GitHub and allow access to all repositories if prompted. 5. Fork this repo. -6. After forking the repo, open the [`vercel.json`](https://github.com/anuraghazra/github-readme-stats/blob/master/vercel.json#L5) file and change the `maxDuration` field to `10`. -7. Go back to your [Vercel dashboard](https://vercel.com/dashboard). -8. To import a project, click the `Add New...` button and select the `Project` option. +6. Go back to your [Vercel dashboard](https://vercel.com/dashboard). +7. To import a project, click the `Add New...` button and select the `Project` option. ![](https://files.catbox.moe/3n76fh.png) -9. Click the `Continue with GitHub` button, search for the required Git Repository and import it by clicking the `Import` button. Alternatively, you can import a Third-Party Git Repository using the `Import Third-Party Git Repository ->` link at the bottom of the page. +8. Click the `Continue with GitHub` button, search for the required Git Repository and import it by clicking the `Import` button. Alternatively, you can import a Third-Party Git Repository using the `Import Third-Party Git Repository ->` link at the bottom of the page. ![](https://files.catbox.moe/mg5p04.png) -10. Create a personal access token (PAT) [here](https://github.com/settings/tokens/new) and enable the `repo` permissions (this allows access to see private repo stats). -11. Add the PAT as an environment variable named `PAT_1` (as shown). +9. Create a personal access token (PAT) [here](https://github.com/settings/tokens/new) and enable the `repo` permissions (this allows access to see private repo stats). +10. Add the PAT as an environment variable named `PAT_1` (as shown). ![](https://files.catbox.moe/0yclio.png) -12. Click deploy, and you're good to go. See your domains to use the API! +11. Click deploy, and you're good to go. See your domains to use the API!