DEV Community

loading...
Cover image for Creating a profile README on GitHub

Creating a profile README on GitHub

Walter Nascimento
Software development | PHP | JavaScript | Database | Open-Source
Updated on ・2 min read

[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.

https://github.com/walternascimentobarroso/walternascimentobarroso

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:

https://visitor-badge.laobi.icu/
https://hitcounter.pythonanywhere.com/
https://hits.dwyl.com/
https://github.com/arturssmirnovs/github-profile-views-counter

Quotes

How about adding quotes to your readme dynamically?

For this use the link below

https://github.com/shravan20/github-readme-quotes

for more information read the project readme or this post

https://dev.to/imshravan/github-profile-readme-animated-dynamic-quote-generator-4le6

WakaTime Details

If you want to include more data in your readme, a great option is https://github.com/anmol098/waka-readme-stats

Inspirations

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

https://github.com/coderjojo/creative-profile-readme

Generator

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

https://rahuldkjain.github.io/gh-profile-readme-generator/
https://arturssmirnovs.github.io/github-profile-readme-generator/


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! 😊😊

Discussion (4)

Collapse
imshravan profile image
Shravan Kumar B

Hi, do check this project, to beautify your profile readme. Star it, if you like it.

GitHub Dynamic Animated Quote Generator

GitHub logo shravan20 / github-readme-quotes

Dynamic quote generator for your GitHub readmes

github-readme-quotes

Dynamic quote generator for your GitHub readmes

banner

alt PRs Welcome Open Source? Yes! GitHub contributors Pull Request Counts last commit deployment-status



Note: To read an article on this project, please refer GitHub Profile README : Animated Dynamic Quote Generator


Github Readme Quotes

Copy and paste the following markdown content to display the quote.

![Quote](https://github-readme-quotes.herokuapp.com/quote)
Enter fullscreen mode Exit fullscreen mode


  • Themes

You can display your quote in different themes without any manual customization.

Use ?theme=THEME_NAME parameter as shown below.

![Quote](https://github-readme-quotes.herokuapp.com/quote?theme=dark)
Enter fullscreen mode Exit fullscreen mode

Available Themes

dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula

Gotham

Quote

Dark

Quote

Light Theme

Quote

You can explore different themes here.

Feel free to contribute different themes.


  • Layouts

You can also change the layout of your templates.

Use ?layout=LAYOUT parameter as shown below

![Quote](https://github-readme-quotes.herokuapp.com/quote?theme=dark&layout=socrates)
Enter fullscreen mode Exit fullscreen mode

Layout 1 (Default)

Quote

Layout 2 (Socrates)

Quote

You can explore different layouts here.

Feel free to contribute different layouts.


  • Animations

You can also add animations to your templates.

Use…




Collapse
walternascimentobarroso profile image
Walter Nascimento Author

I liked it, I already gave it a star;)

I'll update the post and add it, thanks ;)

Collapse
harshhhdev profile image
Harsh Singh

Another cool thing you should add is waka readme stats, to show how many people visit your profile 😄

You can also take a look at my readme for inspiration if you're going for a code-themed readme 😉

Collapse
walternascimentobarroso profile image
Walter Nascimento Author

Thank you, I really liked your readme.

And the waka-readme-stats is really cool, I'll update the post and add it, thanks ;)