Exemplo de readme base para repositórios

examplo_readme.md

🚀 Nome do Projeto

Escrever uma breve descrição

Objetivo • Roadmap • Tecnologias • Contribuição • Licença • Autor

🚧 Projeto 🚀 Em construção... 🚧

✔️ Features

• Cadastro de usuário
• Cadastro de cliente
• Cadastro de produtos

📝 Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js. Além disto é bom ter um editor para trabalhar com o código como VSCode

🎲 Rodando o Back End (servidor)

# Clone este repositório
$ git clone <https://github.com/tgmarinho/nlw1>

# Acesse a pasta do projeto no terminal/cmd
$ cd nlw1

# Vá para a pasta server
$ cd server

# Instale as dependências
$ npm install

# Execute a aplicação em modo de desenvolvimento
$ npm run dev:server

# O servidor inciará na porta:3333 - acesse <http://localhost:3333>

🛠 Tecnologias

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

• Expo
• Node.js
• React
• React Native
• TypeScript

🤔 Como contribuir

• Faça um fork desse repositório;
• Cria uma branch com a sua feature: git checkout -b minha-feature;
• Faça commit das suas alterações: git commit -m 'feat: Minha nova feature';
• Faça push para a sua branch: git push origin minha-feature.

Depois que o merge da sua pull request for feito, você pode deletar a sua branch.

⚖️ Licença

🎨 Author

Made with 💜 by Ronnasayd Machado 👋 Get in touch!