How to make a GitHub profile README

12 Jul 2020

GitHub profiles are now live!

New GitHub profile now live ✨https://t.co/bb8I1khju6 pic.twitter.com/cRFW8AKASl

— Joshua Byrd (@phocks) July 11, 2020

I first saw this feature being teased a little while back in this post and I was pretty excited, but I’ve been waiting a while for it to become an actual thing. Finally they’re here!

hey, so we heard ya & are trying out a thing where you CAN have a readme on your @github profile... @mikekavouras built it btw! re: https://t.co/UC6q3qHjjR pic.twitter.com/kB0kafgovY

— kathy ☁️ (@pifafu) May 27, 2020

Looks like they used to be done with a .github/README.md repo and file. But it seems like they’ve changed things a little. Here’s how you do it.

1. Make a repository with the same name as your GitHub username.
2. Create a README.md file inside that repo.
3. Commit and push the file to GitHub
4. Click the “Share to Profile” button in the sidebar.

That’s it. Now check your GitHub profile. It should look a little like this.