DEV Community

Cover image for How to add README to your GitHub profile
Moralist Festus
Moralist Festus

Posted on

How to add README to your GitHub profile

Github has just introduced another amazing feature that allows users to add a README file to their github profile. How amazingly it is ☺, This feature allows user to create a more precise profile description on their github profile.

Why README?

The GitHub PROFILE README feature allows more content than the profile bio, supports markdown which means you can play around with the content more visually and the README is more visible as it is placed above pinned repositories and takes up as much space above the fold of the webpage as you like.
The README makes your profile great looking as you can add texts, animations, colored texts, images, links etc.

How to create a profile README?

It is as simple as you'd ever imagine ☺
step 1:
Create a new repository, the name of your repo should be same with your GitHub profile name. For example, my Github profile name is MoralistFestus, so I named mine MoralistFestus.

step 2:
Now github will prompt a message "You found a secret! githubusername/githubUsername 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." Github will be surprised you just found a new secret 😂. That's amazing.

step 3:
Initialize it with a README.md and commit your new repository. Now you can upload a file of your README.md from your computer, the README.md file can contain mark down, images, links, gif etc.

That's all, Go. check your profile and see it is done.
Thanks you for reading, if you love my article, do follow and get latest articles. ☺ 🔥

Oldest comments (0)