Criei um README atrativo, usando Badges para indicar as tecnologias e um GIF animado para mostrar o projeto em funcionamento antes mesmo de a pessoa baixar o código.
O que acharam da organização do README? Aceito sugestões e feedbacks!
Você está vendo a versão anterior da nova experiência da Alura que estamos preparando para você. Em breve, ela ganha uma identidade visual novinha totalmente pensada em potencializar seus estudos!
Criei um README atrativo, usando Badges para indicar as tecnologias e um GIF animado para mostrar o projeto em funcionamento antes mesmo de a pessoa baixar o código.
O que acharam da organização do README? Aceito sugestões e feedbacks!
Olá, Rian. Como vai?
Parabéns pela dedicação no desafio! A sua iniciativa de incluir um GIF animado e badges no README é excelente. Isso faz uma diferença enorme, pois a primeira coisa que recrutadores e outros desenvolvedores olham em um repositório é justamente a documentação visual e clara do projeto.
Pela imagem que você compartilhou, a estrutura do seu repositório já está bem legal, inclusive com o uso correto do .gitignore. Para deixar o seu README e o repositório ainda mais profissionais, deixo aqui algumas sugestões de organização:
Estruture em tópicos: Dividir o README em seções claras ajuda muito a leitura. Você pode incluir títulos com a formatação Markdown, como Sobre o projeto, Tecnologias utilizadas, Como executar o projeto e Contato.
Posicionamento estratégico: Uma prática comum e muito atrativa é colocar as badges de tecnologia logo abaixo do título principal. Já o seu GIF animado pode ganhar um destaque especial dentro de uma seção chamada Demonstração ou Preview.
Organização dos arquivos de mídia: Notei que os arquivos preview.gif e rian.jpg estão na raiz do seu repositório. Uma dica bacana para os seus próximos projetos é criar uma pasta chamada assets ou img apenas para guardar essas imagens. Isso deixa a raiz do seu repositório mais limpa, focada apenas nas pastas de código e arquivos de configuração.
Continue com esse capricho, pois um bom README é o melhor cartão de visitas para o seu código!
Espero que possa ter lhe ajudado!