A Developer's Guide to github-readme-stats
anuraghazra/github-readme-stats
As a software engineer, you spend a lot of time on GitHub. This tool lets you show off your work directly on your profile or repository README. It's useful for a few reasons
Quick Visuals
Instead of manually listing your stats, you get a clean, automatically updated card that displays your contributions, top languages, and more.
Serverless & Dynamic
It uses a serverless function, so you don’t need to host or maintain anything. The stats are generated dynamically, meaning they're always up-to-date with your latest activity.
Flexibility
You can customize the look and feel to match your personal brand or project's theme. This includes colors, themes, and what information is displayed.
Portfolio Enhancement
It makes your GitHub profile more engaging and professional, which can be a big plus when recruiters or other developers view your page.
Getting this set up is super easy. You don't need to be a DevOps wizard or anything; it’s just a simple URL you add to your README.
Go to the README.md file of your profile or repository and add an image tag. This is the simplest way to get a basic stats card.
Important
Make sure to replace YOUR_USERNAME with your actual GitHub username.
Save the changes to your README.md file and push them to your GitHub repository. The stats card will automatically appear, showing your contributions.
The real power of this tool comes from its customization options. You can add URL parameters to the image URL to change its appearance and content.
| Parameter | Description | Example |
username | (Required) Your GitHub username. | username=octocat |
show_icons | Shows icons next to the labels. Set to true. | show_icons=true |
theme | Changes the color theme of the card. | theme=dark |
hide_rank | Hides the contribution rank. Set to true. | hide_rank=true |
title_color | Sets the color of the card's title. Use a hex code. | title_color=0f969c |
hide | A comma-separated list of stats to hide. | hide=contribs,prs |
count_private | Includes private contributions in the count. Set to true. | count_private=true |
You can combine these parameters using & in the URL.
Here's a more complete example with some customization. This shows how you can create a stats card and a top languages card.
This URL generates a stats card with a custom theme, icons, and a custom background.
### My GitHub Stats
This URL creates a separate card that shows your most-used languages. It's a great way to highlight your polyglot skills.
### My Top Languages
