GitHub recently released a feature that allows users to create a profile-level README to display prominently on their GitHub profile. The GitHub profile-level README feature allows more content than the profile bio, supports markdown which means you can play around with the content more visually (Did someone say GIFs!?) and the README is significantly more visible as it is placed above the pinned repositories and takes up as much space above the fold of the webpage as you like.
How do I create a profile README?
The profile README is created by creating a new repository that’s the same name as your username. For example, my GitHub username is minu27 so I created a new repository with the name minu27. Note: at the time of this writing, in order to access the profile README feature, the letter-casing must match your GitHub username.
- Create a new repository with the same name (including casing) as your GitHub username: https://github.com/new
- Create a README.md file inside the new repo with content (text, GIFs, images, emojis, etc.)
- Commit your fancy new README!
If you’re on GitHub’s web interface you can choose to commit directly to the repo’s main branch (i.e.,
main) which will make it immediately visible on your profile)
4. Push changes to GitHub (if you made changes locally i.e., on your computer and not github.com)
That’s it your profile is now ready. 😍
Do visit my GitHub Profile and provide some feedback.