Creating a profile README on GitHub

Walter Nascimento
Walter Nascimento | EN
3 min readNov 6, 2020

Creating a readme for your GitHub profile

[Clique aqui para ler em português]

GitHub now allows you to create a repository with your username and the readme for that repository is displayed on your profile page.

In practice

First access your GitHub profile and create a new repository with your username, mine was like this.

After the project has been created, add a readme, and use the markdown to make your readme excellent.

Shield

It is common to use shield.io to create small images to improve the readme layout, creating some medals.

Emoji

For a more elegant layout we can use emoji, for references we have both Emojipedia and EmojiCheat.

Hit Counter

To mark how many visits your profile is receiving you can use the links:

Quotes

How about adding quotes to your readme dynamically?

For this use the link below

for more information read the project readme or this post

WakaTime Details

If you want to include more data in your readme, a great option is:

Inspirations

If you need some examples of inspiration, this repository has several.

Generator

And finally, if you are not up to your creativity at the moment, you can use the generators below:

Thanks for reading!

If you have any questions, complaints or tips, you can leave them here in the comments. I will be happy to answer!

😊😊 See you! 😊😊

--

--