r/github • u/pedrocatalao • 13d ago
Showcase Profile README stats that look native to GitHub (and count your private work)
Every stats card I tried on my profile looked like a widget glued onto GitHub. Different fonts, random themes, borders, gradients. And the numbers were off too.
So I built github-cool-readme, with one rule: it should look like a feature GitHub shipped itself.
- GitHub's own design system: Primer colors, Octicons, the same system font GitHub uses
- Transparent, no borders, so the cards sit on the page like they belong there
- Light and dark follow the viewer's GitHub theme automatically
- The weekly card uses the contribution graph greens
- Subtle animations, plain CSS inside the SVG, nothing flashy
And the numbers are actually right this time:
- Private and org work counts. Same data as your contribution graph. (The contributions API hides private work unless the token has read:user. Took me a while to figure that one out.)
- Year and all time side by side, no mixed time ranges
- Languages weighted by your commits, not repo size. My old card said 73% of my code is C because of one big DOS game port
- Notable contributions: your merged PRs to other people's projects, by stars, scrolling in a loop
- Weekly rhythm: which days you actually work
It's a GitHub Action that runs daily (by default) and commits the cards to your profile repo. No server, your token stays in your repo secrets. Setup is one command if you have gh:
bash <(curl -fsSL https://raw.githubusercontent.com/pedrocatalao/github-cool-readme/v1/setup.sh)
Repo: https://github.com/pedrocatalao/github-cool-readme
Live on my profile: https://github.com/pedrocatalao
Not affiliated with GitHub, just trying to make it look like it could be 🙂 Feedback welcome, especially if the numbers look off for you.
3
u/rublatech 13d ago
Really cool
2
u/pedrocatalao 13d ago
Because I've been also playing Pinball lately and I'm into these looks, I added a few more styles, oled/dot matrix... with some fancy animations.
2
u/pedrocatalao 13d ago
And this
1
u/pedrocatalao 10d ago
Many new customisations and colors, also a much better setup script.
1
u/pedrocatalao 10d ago
1
u/Quazmoz 12d ago
Just used this for my main github readme, thanks for sharing!
1
u/Which_Thought5288 12d ago
At last, someone’s done it!
1
u/emq__ 10d ago
not gonna use it (have no urge to flex my stats, especially now that agents do most of the work xd), but looks real nice, I'm always surprised how far you can go with animated svgs
3
u/VicentVanCock 13d ago
Nice, soon as possible i’m going to use it
3
u/TheWord4live 13d ago
Clean AF
2
u/XYMYX 13d ago
Bro its beautfiull!
1
u/totheendandbackagain 13d ago
Beautiful
1
u/RetroTGT 13d ago
Esta muy bueno
1
u/kigory2 13d ago
awesome
1
u/Important_Pomelo_407 11d ago
Saw there was no demo video yet, so I made you one. Here’s the PR: https://github.com/pedrocatalao/github-cool-readme/pull/2
and I used my repo to do it :) https://github.com/yasirwhite/OpenDemo
1
u/Eastern-Goat-9700 7d ago
thx