DEV Community

Cover image for πŸš€ Quick guide to set up and customize your GitHub profile README
Laura Grassi
Laura Grassi

Posted on

πŸš€ Quick guide to set up and customize your GitHub profile README

Customizing a README in your GitHub profile can serve several purposes.

Github Profile

Firstly, it provides visitors to your profile with an immediate introduction to who you are, what you do, and what you're interested in. This can include information about your projects, your skills, and your goals.

Secondly, you can use the README to showcase your projects, including descriptions, screenshots, and links. This helps highlight your skills and accomplishments to anyone viewing your profile. Moreover, customizing your README allows you to express your personality and personal style, making your profile more memorable and unique. Additionally, a well-crafted README can engage visitors to your profile, encouraging them to explore your projects further, follow you, or even reach out to collaborate.

Finally, if you're working on open-source projects, a detailed README can serve as documentation for other developers who may want to use or contribute to your projects. In essence, customizing a README in your GitHub profile helps you make a strong first impression, showcase your work effectively, and connect with others in the developer community. It's a valuable tool for personal branding, networking, and sharing your skills and projects with the world.

To start, let's first create the README and add it to your profile:

Button new repository
1. In the top right corner of any page, select the "+" icon and click on "New Repository".
2. In "Repository name", type a name that EXACTLY matches your GitHub username. For example, if your username is "test123", the repository name MUST be "test123".
3. Optionally, in the "Description" field, add a description for your repository. For example, "My beautiful repository."
4. Select "Public".
5. Check the option "Initialize this repository with a README".
6. Click on "Create Repository".
7. Above the right sidebar, click on "Edit README".


  • Use GitHub Markdown (Doc about
  • Start simple (because thinking about what to write always takes time).
  • Language: depends on your target audience, I usually always choose English as it's the "universal language".
  • Your GitHub profile doesn't need to be super formal like LinkedIn (although it's important to remember that it can be seen by anyone, both colleagues and potential tech recruiters, so try not to get TOO carried away hahah).

Badges examples


  • Badges highlight your skills (the "markdown-badges" has plenty of variety).


  • I'm biased because I love reading books and because of that, I have endless lists of quotes that I would like to spread around the world, but I confess that the vast majority of people don't add quotes to their profile, so like all the other items: it's a matter of taste."github-readme-quotes" automatically generates quotes for you if necessary.


✨Emojis and Statistics:

  • Statistics: And to be honest, this is a controversial topic, some say it's not worth it, but it's up to you... You can use "github-readme-stats" to add statistics (you can even customize your cards with different layouts and themes).
  • Emojis ("emoji-cheat-sheet").


  • One way to improve the accessibility of your profile is by adding descriptive alternative text for your images since there are some people have disabilities, while others have slow internet connections.

There are several online options for some readme generators with a slightly more user-friendly interface. Among the options are:

In the end, let creativity guide you.

Top comments (0)