phocks a dev blog

How to make a GitHub profile README

GitHub profiles are now live!

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!

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.