github-readme-stats icon indicating copy to clipboard operation
github-readme-stats copied to clipboard

Published 20 hours ago • verified publisher icon anuraghazra

Improve caching documentation

Open rickstaa opened this issue 2 years ago • 5 comments

Is your feature request related to a problem? Please describe.

I noticed many problems people have in issues and discussions are caused by the fact that they are not aware that we use caching to reduce the server load.

Describe the solution you'd like

Although this is explained in the README, it is placed under the gradient section (See https://github.com/anuraghazra/github-readme-stats#gradient-in-bg_color). Let's add a separate area to describe the caching behaviour.

rickstaa avatar May 18 '22 08:05 rickstaa

I'm Interested in tackling this. Can you assign to me?

Thanks

coderboy-exe avatar Jul 15 '22 14:07 coderboy-exe

@coderboy-exe Thanks for your interest in contributing to GRS. 🚀 I assigned you to this issue. Tale your time. Let me know if you have any questions, and feel free to request a review from me at the PR.

rickstaa avatar Jul 15 '22 15:07 rickstaa

The code related to the caching behaviour can be found here might you need it as a reference:

https://github.com/anuraghazra/github-readme-stats/blob/a68abbb9b3a47ad73988f37fce274e882e86b7ad/api/index.js#L54-L60

rickstaa avatar Jul 15 '22 15:07 rickstaa

Awesome! I'll keep in touch

coderboy-exe avatar Jul 15 '22 15:07 coderboy-exe

Well,I think you can do @coderboy-exe

muhibarshad avatar Jul 19 '22 17:07 muhibarshad

@coderboy-exe Are you still working on this issue, or can others take it on for their Hacktoberfest?

rickstaa avatar Oct 03 '22 08:10 rickstaa

Implemented in d7451d8288d700d9695689a8d2a3076994e29d22.

rickstaa avatar Oct 07 '22 12:10 rickstaa