How to create an awesome Github README

Versão em PT-BR aqui.

Introduction

Github is the most popular service used by developers in the world, or following the company slogan "Where the world builds software".

But, in addition to all the features, you can also, Github can be considered a developer's social network and just like all networks, its interessting you have a good profile in your main page.

So, you can create a "profile readme", a file with the same name that your @, it's fully custom and you can use Markdown and HTML to do this.

Today I'll show you hot to write a cool personal readme file for your profile, with a lot of integrations and features, like this.

OBS.: There is a lot of ways to do this, I'll just explain some of them today, but I'll let some usefull links to others options.

Let's Start

To active this resource, you just need to create a repository with the same name of your @ and create a READE.md file inside:

Now, you can open the file to start to put your readme code. If you never worked with Markdown files, you can follow this guide here.

There are a lot of models to your README, I'll let some examples bellow to get you inspired:

Awesome GitHub Profile README

Awesome GitHub Profile README Template Collection

Badges

You can add Badges in your profile to represent your social medias, your technologies of interest, your tools, etc.

The best website to get or generate a custom badge is Shields.io.

Also, there are two others very cool repositories with a copy and paste system, to you get your badges:

Markdown Badges by Ileriayo Adebiyi

Badges by Aleen

You can also add your tecnologies as a simple image, following this repo:

Tech-Icons by Workshape.io

All of the ways will generate a line of code that you can copy and paste in your README.

Stats

Another cool feature to you add on your profile, is your statistics (numbers of commits, techs more used, pull requests, etc).

Just like the badges, you just need to put a line of code inside your file, following the repository tutorial:

GitHub Readme Stats by Anurag Hazra

Waka Readme Stats by Anmol Pratap Singh - It is necessary to create an account

Integrations

In addition to "decorations" and styles, you can also integrate other services in your profile, I'll leave the most common and popular ones below:

Discord - Discord Banner - you will need to access your discord profile, activate developer mode, and redeem your API Key to make this integration.

Spotify - Spotify Github Profile - just click the Connect with Spotify button and enable the integration.

DEV.to - Latest Post

Images

You can add images and animations on your profile too, this can be do using the native Markdown resource (just create a folder to upload the images and reference them). But there are some cool alternatives too:

Readme Typing SVG

README Header Image Generator

Ok, now you can create an awesome Github Readem Profile, please share the link in comments if you want.

I hope you enjoyed it, see you. ✌️