Why I Updated My GitHub README

#programming #github #markdown #devjournal

GitHub: the developer playground. It's where you build, break, and show off your work It's also where you can flex your markdown skills.

One of the lesser-known features is the special repository that powers your GitHub profile README. I've had mine for about three years, untouched. It was long overdue for an update.

Why I Decided to Change It

My old README was a relic of who I used to be. I had thrown it together using a template from gh-profile-readme-generator back when I was just starting out. It served its purpose, but I've grown a lot since then, both as a developer and as a person.

Now, with a few more years of experience under my belt, I wanted my profile to reflect where I am now. Time for a refresh.

Finding Inspiration

I started where any dev starts: Google.

After a bit of searching, I stumbled upon this gem:
awesome-github-profile-readme. It's a massive collection of creative profile READMEs from other developers. I went through every single one (yes, really), taking notes on the pieces I liked while still trying to keep my profile uniquely mine.

What I Used to Build My New README

Here's a breakdown of the tools and repos that helped bring my new README to life:

Blog Post Automation: blog-post-workflow - auto-pulls in my latest blog posts
GitHub Stats: github-readme-stats
Typing Title: readme-typing-svg
Contribution Streaks: github-readme-streak-stats
Skill Icons: gh-profile-readme-generator, GPRM

All of these had fantastic documentation and were super easy to plug in.

A Custom Touch - Chess Stats

While browsing through sciencepal's profile, I noticed something that was super cool. They were tracking their progress on chess.com.

As an avid chess player, I had to have one too. So, I built my own:
➡️ Chess Stats Card

It shows your latest ranks in Daily, Blitz, Bullet, and Rapid. It even includes your league and profile picture. It's simple for now, but I'm planning to keep improving it.