How to add GitHub stats to your profile README
Updated
Your GitHub profile README is the repository named after your username (for example octocat/octocat). Whatever is in its README.md shows at the top of your profile, which makes it the best place for stats that update themselves.
1. Create your profile README
On GitHub, create a new public repository with exactly your username as its name and tick "Add a README file". GitHub will tell you it's a special repository when the name matches.
2. Put your stats on DevTrack
The badges below are rendered from your real GitHub activity. Sign in with GitHub and your profile, streak and rank are built for you. The rank badge needs you on the public leaderboard, which you can turn on in Settings.
3. Paste the badges
Replace YOUR_LOGIN with your GitHub username:
[](https://devtrack.live/u/YOUR_LOGIN)
[](https://devtrack.live/u/YOUR_LOGIN)
[](https://devtrack.live/u/YOUR_LOGIN)The rank badge also takes &board=month or &board=week to show this month's or this week's board instead of all time.
4. Commit, and you're done
The badges are SVG images served with short caches, so they refresh on their own. GitHub proxies README images through its camo cache, so a change can take a little while to appear.
Tips
- Keep it to two or three badges; a wall of badges reads as noise.
- Link each badge to your DevTrack profile so visitors can see the full card.
- Want to see where you'd rank first? Try any username in the score attack on the home page.
Quick answers
- How do I show GitHub stats in my README?
- Create a public repository named after your GitHub username, add a README.md, and paste image badges that link to a stats service. DevTrack's rank, streak and monthly commit badges update automatically from your GitHub activity.
- Do README stat badges update automatically?
- Yes. They are images rendered on request from your current GitHub data. GitHub caches README images briefly, so changes can take a little while to show.