Como criar um README para o seu perfil do Github
Tags: github, readme, markdown
Published: 2021-12-14 15:21:30

> English version [here.](https://dev.to/akadot_/how-to-create-a-awesome-github-readme-4mb4)

## Introdução

O **Github** é um dos serviços mais utilizados por desenvolvedores em todo o mundo, ou como o próprio slogan diz _"Onde o mundo constrói seus softwares"_.

Porém, além de todas as funcionalidades que você já deve conhecer, o Github pode também ser considerado uma **rede social para desenvolvedores** e, como toda rede social, é interessante ter um bom perfil inicial, para que as pessoas possam te conhecer melhor logo no primeiro acesso. 

Para isso, seu perfil pode possuir um _"profile readme"_, um arquivo com o seu nome que será exibido em sua página inicial, ele é totalmente customizável, visto que é um arquivo **Markdown** que suporta tags **HTML** e outros recursos.

Hoje vou mostrar a vocês como podemos criar um README bem legal com diversas integrações e funcionalidades, assim como o [meu](https://github.com/akadot/akadot).

_OBS.: Existem inúmeros recursos que podem ser adicionados ao seu README, irei explicar apenas alguns que utilizo ou utilizei, mas deixarei links para todos os outros._

## Mão na Massa

Para ativar esse recurso em seu perfil, basta criar um repositório com o mesmo nome do seu perfil (seu @ no caso), e criar um arquivo **README.md** dentro dele, dessa forma:


![Meu Repositório Readme](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/za6s11voi3z426jkacn8.png)


![Meu Repositório Readme](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/3356pcooemkm0bkwri21.png)

Feito isso, abra o arquivo que criou, no editor do Github mesmo, e começaremos a editar. Caso não tenha experiência em arquivos Markdown, pode acessar a [esse guia](https://docs.pipz.com/central-de-ajuda/learning-center/guia-basico-de-markdown#open) da linguagem e acompanhar por ele, é bem tranquilo.

Existem milhares de modelos e maneiras de criar seu README, deixarei abaixo alguns repositórios com ideias que podem te inspirar:

[Awesome GitHub Profile README](https://github.com/abhisheknaiidu/awesome-github-profile-readme)

[Awesome GitHub Profile README Template Collection](https://github.com/durgeshsamariya/awesome-github-profile-readme-templates)

Alguns são bem simples e objetivos, outros são mais completos e cheios de recursos, veremos alguns deles a seguir.

### Badges

Você pode adicionar **Badges** ao seu perfil, para representar suas redes sociais, tecnologias que domina ou está aprendendo, projetos e estados de projetos e diversas outras coisas.

O melhor site para gerar e adicionar essas badges, é o [Shields.io](https://shields.io/). Nele você pode criar e editar suas próprias badges, ou selecionar alguma já pronta.

Existe também 2 repositórios muito interessantes, com badges prontas e em um sistema de copia e cola:

[Markdown Badges](https://github.com/Ileriayo/markdown-badges) do [Ileriayo Adebiyi](https://github.com/Ileriayo)

[Badges](https://github.com/aleen42/badges) do [Aleen](https://github.com/aleen42)

Você também pode adicionar suas tecnologias e ferramentas de interesse/domínio como simples imagens, para isso existem os repositórios:

[Tech-Icons](https://github.com/Workshape/tech-icons) da [Workshape.io](https://github.com/Workshape)

Todas as opções vão gerar uma linha de código, basta inserir no seu arquivo README.


### Stats

Outra opção legal de adicionar em seu perfil, são as **estatísticas** de linguagens utilizadas, número de commits, repositórios, pull requests e afins.

Assim como as badges, basta adicionar um linha de código em seu perfil README, seguindo os repositórios abaixo e adicionando seu @, para que suas estatísticas sejam geradas:

[GitHub Readme Stats](https://github.com/anuraghazra/github-readme-stats) do [Anurag Hazra](https://github.com/anuraghazra)

[Waka Readme Stats](https://github.com/anmol098/waka-readme-stats) do [Anmol Pratap Singh](https://github.com/anmol098) - **Necessário criar uma conta**


### Integrações

Além de "decorações" e estilos, você também pode integrar outros serviços em seu perfil, deixarei abaixo os mais comuns e populares:

**Discord** - [Discord Banner](https://github.com/dgibbs64/discord-banners) - você precisará acessar seu perfil no discord, ativar o modo desenvolvedor e resgatar sua API Key, para fazer essa integração.

**Spotify** - [Spotify Github Profile](https://github.com/kittinan/spotify-github-profile) - basta clicar no botão Connect with Spotify e permitir a integração.

**DEV.to** - [Latest Post](https://github.com/gautamkrishnar/blog-post-workflow)

### Imagens

Você também pode utilizar imagens e animações em seu perfil, isso pode ser feito utilizando o recurso nativo de imagens do Markdown (basta criar uma basta no seu repositório, adicionar as imagens e referenciar elas). Mas também existem alternativas bem legais para isso:

[Readme Typing SVG](https://github.com/DenverCoder1/readme-typing-svg)

[README Header Image Generator](https://github.com/khalby786/REHeader)


Pronto, com isso você conseguirá montar um readme show, fique a vontade de compartilhar seu perfil nos comentários.

Espero que tenham gostado, até mais. ✌️