How to add a README to your GitHub Profile

How to add a README to your GitHub Profile.

GitHub released a feature to enable users add README to their GitHub profile. In this article I share steps on how to achieve this.

Most developers want to secure better jobs, get awesome opportunities or relocate to a different country. The GitHub profile README gives you the avenue to tell people who you are, what you do and how to connect with you. It's your space; make good use of it.

Getting Started

The GitHub profile README feature supports HTML, markdown, images etc. and is positioned above pinned repositories hence draws attention. Note that your repository must be public before your GitHub profile README can be displayed.

To get started, visit https://github.com/new and create a new repository with the same name and letter case as your GitHub username. Once you type your username, a screen similar to the image above would be displayed.

Initialize a README file and create the repository or clone the repository and create a README.md file locally. Initializing a README file populates the README.md with the default content similar to what is shown below. It generates your profile automatically.

### Hi there 👋
<!--
**chiamakaikeanyi/chiamakaikeanyi** is a ✨ _special_ ✨
repository because its `README.md` (this file) appears on
your GitHub profile.
Here are some ideas to get you started:
- 🔭 I’m currently working on ...
- 🌱 I’m currently learning ...
- 👯 I’m looking to collaborate on ...
- 🤔 I’m looking for help with ...
- 💬 Ask me about ...
- 📫 How to reach me: ...
- 😄 Pronouns: ...
- ⚡ Fun fact: ...
-->

Edit the README.md and push the changes or just commit to the repository's main GitHub branch if you're using GitHub web interface.

That's it! Creating a GitHub profile README in 4 steps.

Check out Wes Bos' Mastering Markdown Mini Series if you're not conversant with Markdown.

Article Tag  Workflow Tooling

Share this article:

Subscribe to the Newsletter

More Articles


Author
Chiamaka Ikeanyi.

I write about accessibility, performance, JavaScript and workflow tooling. If my articles have helped or inspired you in your development journey, consider supporting me.

Become a PatronFollow Chiamaka Ikeanyi on Twitter