Adding a README to your GitHub profile

Tom Bonanni
2 min readOct 20, 2021
easter egg

Hi all! Today I’m going to show you a secret on GitHub that allows you to add a README to your public profile. Adding a README to your public profile is a great way to distinguish yourself from other GitHub profiles and gives you a way to provide a rich and full experience for your visitors. This is how it’s done:

Step 1:

Create a new repo:

Step 2:

Make the repo name the same as your username. In my case, I set the name of the repository as redhair

You can see in my example that I already have a README in my profile so it warns me that the repo already exists, but if you look below that warning you can see:

You found a secret! redhair/redhair is a ✨special ✨ repository that you can use to add a README.md to your GitHub profile. Make sure it’s public and initialize it with a README to get started.

Awesome! We found an easter egg! Now just make sure to check the “Add a README file” down below and click the “Create repository” button.

If you go back to your GitHub profile you should now see a README at the top. You can edit this README by clicking on the pen icon on the top right:

From there you can treat it like a normal README. It supports markdown syntax and badges like any other README on GitHub. Now the rest is up to you to create a unique and creative README that stands out.

If you’re wondering about me I’m a Full Stack developer who loves to create new things. If you’re curious about what my README looks like or if you need some inspiration, check out my GitHub profile. If you like what you see make sure to follow!

--

--