GitHub Readme Stats
Dynamically generated GitHub stats cards for your profile README with customizable themes and layouts.
What is GitHub Readme Stats?
GitHub Readme Stats is an open-source tool that generates dynamic SVG cards displaying GitHub user statistics, top programming languages, pinned repositories, and WakaTime coding activity. It solves the problem of static GitHub profiles by allowing developers to embed live, customizable metrics directly into their README files.
GitHub users who want to enhance their profile READMEs with dynamic statistics, particularly open-source contributors, developers building their portfolios, and teams showcasing project metrics.
Developers choose GitHub Readme Stats for its extensive customization options, multiple card types, reliable self-hosting capabilities, and active maintenance compared to simpler static alternatives.
Overview
:zap: Dynamically generated stats for your github readmes
Use Cases
Best For
- Enhancing GitHub profile READMEs with live statistics
- Showcasing top programming languages across repositories
- Displaying WakaTime coding activity metrics
- Pinning more than six repositories to a GitHub profile
- Creating customized developer portfolio sections
- Self-hosting GitHub metrics to avoid API rate limits
Not Ideal For
- Projects needing instant, real-time statistics updates without caching delays
- Developers wanting plug-and-play private repository stats without any setup or token management
- Users requiring comprehensive language usage analysis including all external contributions
- Teams looking for a fully managed, zero-maintenance service without self-hosting
Pros & Cons
Pros
Offers over 20 built-in themes like radical and dracula, plus extensive color, border, and layout customization via URL parameters, as detailed in the Themes and Customization sections.
Provides stats, top languages, pinned repos, gists, and WakaTime cards, allowing developers to showcase various metrics in their READMEs with multiple layout options.
Supports deployment on Vercel or GitHub Actions to avoid rate limits and enable private stats, with step-by-step guides and environment variables for control, as emphasized in the Important Notices.
Supports over 40 languages and encourages community translations through contributing guidelines, making it accessible to a global audience.
Cons
The public Vercel endpoint is best-effort and prone to rate limits and traffic spikes, forcing users to self-host for production reliability, as warned in the README's Important Notices.
Displaying private repository data requires obtaining a Personal Access Token, deploying a custom instance, and managing environment variables, adding significant setup overhead compared to public stats.
The top languages card excludes contributions to other users' repositories and is limited to the first 100 repos due to GitHub API constraints, as admitted in the documentation.
Cards have aggressive cache durations (e.g., 24 hours for stats), meaning data updates are delayed, and adjusting this requires self-hosting with CACHE_SECONDS environment variable tweaks.
Frequently Asked Questions
Related Projects
readme-md-generator📄 CLI that generates beautiful README.md files
README Typing SVG⚡ Dynamically generated, customizable SVG that gives the appearance of typing and deleting text for use on your profile page, repositories, or website.
Standard ReadmeA standard style for README files
GPRM🏆 Best Profile Generator, Create your perfect GitHub Profile ReadMe in the best possible way. Lots of features and tools included, all for free ! 💫
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.