All About GitHub’s README.

Shashwatee Nanda
McKinley & Rice
Published in
2 min readOct 9, 2021

GitHub, a well-known name in the developer community, is the world’s largest developer community for sharing, discovering and improving the software. GitHub can do it all, from reading fantastic documentation to providing a web-based hosting service with version control.

GitHub discreetly launched a new feature called README profile. The new README profile feature on GitHub is fantastic. This new feature allows users to make README files specific to their GitHub profile, that is displayed prominently on their profile.

So, what’s the exciting thing about this new profile README feature?

The new profile-level README feature on GitHub allows users to display much more content than their bio and integrates GitHub markdown, that basically means you can play about with the content aesthetically attractive by adding emojis, paragraphs, images, links and on and on. For applying headers, paragraphs, emojis, links and most crucially, attractive gifs, GitHub has its own markdown.

You have complete control over how you promote yourself on GitHub by deciding what information to put in your profile README. In your profile README, below are some samples of information that viewers could find fascinating, exciting and informative.

Describe your job and skills in an “About me” section.

Contributions you are proud of as well as information about them.

Advice on how to obtain support in the communities where you are active

If all of the above are true, GitHub will showcase your profile README on your profile page.

  • You have set up a repository with the same name as your GitHub account.
  • The repository is public.
  • In the room of the repository, there is a file named README.md.
  • Any content can be found in the README.md file.

A template for your profile The README is what was previously in the produced README file to help you get started.

For a complete list of all the available emojis and their codes, go here: Emoji cheat sheet.

Here’s is a link to GitHub’s markdown in case you are not familiar with it; go check it out yourself: GitHub Docs Markdown.

Hope you enjoy reading through the blog.

Written by: Sayali Kukkar, Blockchain Engineer.

--

--