How to add a README file to your GitHub profile

README.md markdown files are great for documenting projects, but did you know you can add a README.md file directly to your GitHub profile? GitHub recently released a hidden feature that does just that!

This article will briefly cover how to set up and modify your GitHub profile README.md file.

Instructions

  1. After you have logged into GitHub, click the "New" button to create a new repository.

  2. Make the name of the newly created repository match your GitHub username.

  3. Make sure the the repository is set to public.

  4. Check the "Add a README file" checkbox.

  5. Edit the README.md file directly on GitHub.com or by pulling the repository down to a local directory to edit. The changes will be instantly reflected on your GitHub profile.

You can add text, emojis, images, tables, and anything else you would normally add to a README.md file, using GitHub's flavor of markdown.

For more information about profile README.md files, checkout GitHub's own documentation at:

https://docs.github.com/en/github/setting-up-and-managing-your-github-profile/managing-your-profile-readme

Is there an error, or incorrect information in this post? Let me know!