/github-contributor-stats

:fire: Get dynamically generated Github Contributor stats on your readmes

Primary LanguageTypeScript

GitHub Readme Stats

GitHub Contributor Stats

Get dynamically generated your github contributor stats on your READMEs!

Features

GitHub Contributor Stats Card

Copy and paste this into your markdown content, and that's it. Simple!

My project, which is based on github-readme-stats, focuses on showing GitHub contributor stats and applies the typescript to the original project. Refer to ISSUE#2027. Thank you @anuraghazra for the awesome open-source project!

Change the ?username= value to your GitHub username.

![Taehyun's GitHub Contributor stats](https://github-contributor-stats.vercel.app/api?username=HwangTaehyun)

Demo

Taehyun's GitHub Contributor stats

_Note: Available ranks are S+ (over 10000), S (over 1000), A+ (over 500), A (over 100), B+ (over 50) and B (over 1).

Hiding rank stats

To hide specific ranks, you can pass a query parameter &hide= with comma-separated rank values. If you need to add plus rank (ex. B+) to hide arrays , it is always safe to replace pluses with %2B

![Taehyun's GitHub Contributor stats](https://github-contributor-stats.vercel.app/api?username=HwangTaehyun&hide=B,B%2B)

Themes

With inbuilt themes, you can customize the look of the card without doing any manual customization.

Use &theme=THEME_NAME parameter like so :-

![Taehyun's GitHub Contributor stats](https://github-contributor-stats.vercel.app/api?username=HwangTaehyun&hide=B&theme=default)

All inbuilt themes:- in github-readme-stats' themes

dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula

You can look at a preview for all available themes or checkout the theme config file & you can also contribute new themes if you like :D

Note: The minimum of cache_seconds is currently 4 hours as a temporary fix for PATs exhaustion.

Contributions are welcome!

Made with 🔥 and TypeScript.