Put a README on your GitHub profile

Fri 10, Jul 2020 github

Hi!

I discovered a really nice easter egg in GitHub today! If you create a repository that's named exactly like your GitHub username and put a README.md in there, the rendered README will show up on your profile!

My profile with the README

How?

  1. Create a new repository named as your GitHub username (if your name is Example, name the repository Example); GitHub shows you a green easter egg alert right under the name input if the name is correct
  2. Check that Initialize this repository with a README is on
  3. Click Create repository

Now edit the newly created README.md with the contents you want to show on your GitHub profile.

Editing the README.md


Back to top