DEV Community

Criando Readme incríveis! 📖

Tulio Calil on May 07, 2021

Você sabe criar arquivos readme para seus repositórios de uma forma atrativa e informativa, ou apenas deixa o readme padrão do React (just a joke)...
Collapse
 
lucasscharf profile image
Aleatório

Gostei bastante sobre as dicas. Nunca havia considerado a questão de colocar uma demo ou gifs. Senti falta de falar um pouco sobre configurações/variáveis de ambiente no README. Sinto que isso é algo bem imopratante e que o README é umbom lugar para colocar essas informações.

Fiz um artigo com essa temática no ano passado (dev.to/lucasscharf/como-escrever-u...).

Collapse
 
tuliocalil profile image
Tulio Calil

Valeu!
Sobre o env é uma boa ideia também!
Normalmente eu não menciono as variáveis de ambiente no readme, eu curto documentar elas no .env.example, mas claro, isso é bem pessoal.