Voc sabe criar arquivos readme para seus repositrios de uma forma atrativa e informativa, ou apenas deixa o readme padro do React (just a joke) ?
Nesse post vamos ver alguns exemplos e dicas de como deixar nosso arquivo de readme super legal e organizado, ento vamos por a mo na massa.md.

• Badges
• Logo
• Titulo e descrio
• Gif ou imagem demo
• Sesses
• Sobre
• Como utilizar
• Instalar
• Como rodar e como utilizar
• Demo
• Campos do Github
• Utilize todo o poder do Markdown
• Concluso

generated with Summaryze Forem

Badges

Badges so super legais para adicionar no nosso arquivo, alm de dar um overview super rpido e deixar o projeto bem bonito.
Algumas que eu gosto muito de utilizar so as de tecnologia, dizendo algum framework/lib que utilizei, status da pipeline, stars e licena.
Alguns exemplos legais:



Voc pode criar suas prprias badges utilizando o shields.io ou pode encontrar varias prontas, inclusive nesse repositrio aqui: https://github.com/Ileriayo/markdown-badges.

Logo

Criar uma logo ou utilizar algo pra representar algo super legal e que da um toque super bonito pra o repo, uma dica bem opcional, mas que faz muita diferena.
Uma dica que eu dou pra quem no tem tanta afinidade com design utilizar servios de criao de logo online, como o Launchaco ou encontrar uma logo open source aqui: https://openlogos.org/.

iex -S mix

iex(1)>HttpRequest.execute(5, 'https://www.google.com')

iex(1)>HttpRequest.execute(5, 'https://www.google.com', 'Bearer 123123123')

iex(1)> h(HttpRequest.execute)

Titulo e descrio

Esse super importante, lembre sempre de adicionar o titulo e a descrio do seu projeto de forma simples e bem direta.
Voc pode criar o titulo e logo abaixo a descrio, ou criar uma sesso para a descrio depois do titulo.

Utilize as tags do markdown para isso:

# Meu projetoDescrio do meu projeto...

Gif ou imagem demo

super legal quando a gente entra em um repo e tem logo de cara uma prvia do que esperamos ver, adicionar uma imagem ou um vdeo para isso uma dica super valida.

git clone https://github.com/tuliocll/summaryze-forem.git

cd summaryze-foremyarn#ornpm install

yarn dev#ornpm run dev

Sesses

Eu gosto de dividir o projeto em varias sesses: sobre, como funciona, como instalar etc...

Sobre

Gosto de criar uma sesso de sobre e detalhar mais sobre o projeto, o que me motivou, como ele foi feito etc.

Como utilizar

legal uma parte falando como utilizar o projeto (caso seja necessrio).

Instalar

Uma sesso mostrando comando a comando como instalar o projeto tambm super valido.

Como rodar e como utilizar

Sempre deixo os comandos de como rodar em cada ambiente(caso seja o caso), prontos para serem copiados e colados.

Demo

Caso seja possvel, sempre legal deixar um link de uma demo online, dessa forma, se for um projeto pessoal ou algum estudo que voc fez, quem estiver vendo conseguir ter a experincia de uso sem precisar fazer todo o processo de instalao.

Campos do Github

Preencha campos especficos do github, como: about e as tag.
Ajuda seu repositrio ser encontrado facilmente e deixa mais organizado tambm.

Utilize todo o poder do Markdown

O Markdown nos oferece coisas incrveis, assim como no html conseguimos criar links, tabelas, ttulos e varias outras coisas. Eu recomendo duas coisas aqui nesse ponto, a primeira que voc leia essa documentao sobre as tags do markdown e a segunda um editor em markdown online com varias dessas tags em forma de um editor de texto.

Concluso

Vou deixar aqui alguns repositrios meus que tem uns readme que eu gosto bastante e caso vocs queiram se inspirar.
Conhece algum repo que tem um readme muito legal ? Comenta pra gente!

git clone https://github.com/tuliocll/rn-darkmode.git

yarnounpm install

git clone https://github.com/tuliocll/sagres-bot.git

yarnounpm install

node src/index.js

yarn start#ounpm start