DEV Community

Cover image for Build an awesome GitHub's profile README

Posted on • Originally published at on

Build an awesome GitHub's profile README

GitHub released a new feature that allows users to create a portfolio using a README in a special repository with same name as the username and display it in the user's profile like the cover picture of this post. This article explains how to create that repo step by step and add some tips and tricks that you can use to tweak your own.

How do I create a profile README?

As I've mentioned before, the profile README is created when the user creates a new repository with the same name as its username. For example, my GitHub username is charly3pins so I created a new repository named charly3pins. The steps are the following:

  1. Create a new repository with the same name as your GitHub username going here. Tick the Add a README file option. create repo
  2. Open the generated and you will see the following template: repo template
  3. Uncomment the comments and add some content like text, GIFs, images, emojis, etc. Whatever you want and Markdown accepts it's okay... Sky is the limit! πŸš€ Check out this Markdown Cheatsheet if you need to brush up on Markdown syntax.
  4. Commit your new README. Note that the changes must be in master or main branch, otherwise will not be visible on your profile until you merge the changes in one of those branches.
  5. Push changes to GitHub (if you made changes locally).

Be creative

You can check my GitHub profile and the repo that hosts my README. I've added my dynamic GitHub stats using this repo, there are a lot of more information that you can add in your profiles. Also I've used this site to make the badges displayed for the social networks and the technologies and tools.

My recommendation is to check check this repo to see a lot of GitHub profiles and get some inspiration.

Feel free to comment here or contact me in my social networks for any comment, question or suggestion.

Top comments (2)

parulsinghh95 profile image

This is a great article thank you for the resources!

charly3pins profile image

You are welcome. Glad to help you! Just ping me if you need more help on this :)
Also I posted another one for the same topic regarding the "profile generation" if you want to read it is
Thank you