GitHub Readme Stats
Generates GitHub profile stat cards you can embed in your README.
- Stars
- 79.9k
- Forks
- 38.2k
- Licence
- MIT
- Language
- JavaScript
- Last update
- 1 months ago
- Type
- Dev tool
What it is
GitHub Readme Stats creates small images showing GitHub statistics such as stars, commits, pull requests and issues for any username. You add a link to the image in your profile README, and it updates as the stats change. The README says the project is no longer maintained and points to successor projects, so treat this entry as a reference to the original tool rather than a current recommendation.
- Embed a stats card showing stars, commits and pull requests in a profile README using the public API URL
- Hide selected stats with the hide parameter or show extra ones such as reviews and merged PRs with the show parameter
- Add icons to the stats card with the show_icons option
Great for
- People who want a generated stats card on their GitHub profile README
- Developers who are comfortable deploying a small serverless app with a GitHub token
- Anyone looking at the original project to understand how these cards work
Not ideal for
- Users who need a reliable, actively maintained service: the README says this repository is no longer maintained and recommends GitHub Stats Extended instead
- Anyone who needs private repository statistics on the public instance: the default card only covers public repositories, so private stats require deploying your own instance with your own token
How to get it
- 1
Use it in the browser (or self-host)
Clone the repository
git clone https://github.com/anuraghazra/github-readme-stats - 2
Run it
- Copy the markdown snippet from the README into your profile README.
- Change the username parameter to your GitHub username.
- Optionally add query parameters such as hide or show_icons to adjust the card.
- 3
Get the most out of it
- Use the hide parameter to remove stats you do not want to display
- Use the show parameter to add extra stats such as reviews or merged pull requests
- Deploy your own instance with a personal access token if you need more reliable cards or private statistics
- Consider the GitHub Actions workflow mentioned in the README to generate cards in your profile repository
Downloads
Strengths
- Simple to use: copy a markdown snippet and change the username
- Supports customization through query parameters such as hiding or showing individual stats
- Open source under the MIT license with a large community of users
Trade-offs
- The README says the project is no longer maintained, so it may not receive fixes or new features
- The public Vercel instance can be unreliable due to rate limits and traffic spikes, per the README
- By default it shows only public repository statistics
How it compares
| Project | Stars | Type | Level | Updated | Best for |
|---|---|---|---|---|---|
| github-readme-stats (this) | 79.9k | Dev tool | beginner | 1 months ago | People who want a generated stats card on their GitHub profile README |
| metrics | 17.4k | Dev tool | intermediate | 5 months ago | Developers who want an automatically updated stats card on their GitHub profile README |
| github-trends | 15.9k | App | beginner | 1.8 years ago | Developers who want a profile card showing lines of code by language or repository |
| skill-icons | 13.4k | Other | beginner | 8 months ago | Developers who want a visual skills section on their GitHub profile README |
| chromeless | 13.2k | Library | intermediate | 8.0 years ago | Developers maintaining existing projects that already use Chromeless |
| ice | 18.6k | Framework | intermediate | 7 months ago | Developers who already know React and want a ready-made project structure |
Stats synced from GitHub. The assessment above was drafted with AI from the project's README on 2026-10-29 and may miss recent changes — check the README before relying on a command. MIT licence: free to use, modify and distribute, including commercially, as long as you keep the copyright notice.