GitHub recently released a feature that allows users to create a profile-level README to display prominently on their GitHub profile. This article walksthrough how to access this new feature.
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 significantally more visible as it is placed above pinned repositories and takes up as much space above the fold of the webpage as you like.
A solid README is a core-component of well-documented software and often encourages collaboration by sharing helpful context with contributors. In my opinion, a profile-level README seems like a great extension of a convention a lot of GitHub users are already familiar with. If you’re looking to make project-level READMEs more awesome and helpful check out matiassingers/awesome-readme for resources and examples of compelling READMEs.
How do I create a profile README?
README is created by creating a new repository that’s the same name as your username. For example, my GitHub username is m0nica so I created a new repository with the name naveenjujaray. Note: at the time of this writing, in order to access the profile README feature, the letter-casing must match your GitHub username.
If you already have a project in a repo-named username/username and are interested in setting up a profile-level README, then I recommend either re-naming that repository or re-purposing the existing project’s README based on what makes the most sense in your particular situation.
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., master or main) which will make it immediately visible on your profile.
Push changes to GitHub (if you made changes locally i.e., on your computer and not github.com)
GitHub README profiles are written in Markdown which means you aren’t just limited to texts and links, you can include GIFs and images. Need to brush up on Markdown Syntax? Check out this Markdown Cheatsheet.
Is this how we suppose use github's readme? pic.twitter.com/XvLvCUC6iD— Pouya (@Saadeghi) July 9, 2020
If you’re really ambitious you can use GitHub actions or other automation like bdougieYO or simonw to dynamically pull data into your
I’m a huge proponent that folks should maintain a website they have complete ownership over (even if it’s a no-code website solution) but this is tempting…
I’ve been inspired by the creative
READMEs I’ve seen so far and am looking forward to seeing all kinds of profiles in the upcoming months.