my template for README.md files

README.md

Tabela de conteúdos

• Sobre o projeto
  • Screenshots
  • Tecnologias
  • Como executar
• Como contribuir
• Licença

💻 Sobre o projeto

<REPO_NAME> - <ABOUT_REPO>

📷 Screenshots

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

• Example
• Example
• Example

🚀 Como executar

# Clone o repositório
git clone https://github.com/carlos3g/<REPO_NAME>.git

# Instale as dependências
cd <REPO_NAME>
yarn install

# Rode a aplicação
yarn start

🤝 Como contribuir

Todo tipo de contribuição é bem-vinda!

Tem algum problema? Encontrou um bug? Tem alguma sugestão? Abra uma issue descrevendo.

Quer contribuir com código? Leia este guia de contribuição

Deixar a sua ⭐ também é um modo de contribuir ;)

📝 Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.

---

Criado por Carlos Mesquita 💜