gabrieldejesus / readme-model

💾 A beautiful readme model for you to put in your projects.

Nome do produto

📜 Descrição curta sobre o que seu projeto faz.

💡 De um a dois parágrafos sobre o que é seu projeto e o que ele faz.

🛠 Instalação

OS X & Linux:

npm install my-crazy-module --save

Windows:

edit autoexec.bat

📈 Exemplo de uso

Alguns exemplos interessantes e úteis sobre como seu projeto pode ser utilizado.

Adicione blocos de códigos e, se necessário, screenshots.

Para mais exemplos, consulte a Wiki.

💻 Configuração para Desenvolvimento

Descreva como instalar todas as dependências para desenvolvimento e como rodar um test-suite automatizado de algum tipo. Se necessário, faça isso para múltiplas plataformas.

make install
npm test

🗃 Histórico de lançamentos

• 0.2.1
  • MUDANÇA: Atualização de docs (código do módulo permanece inalterado)
• 0.2.0
  • MUDANÇA: Remove setDefaultXYZ()
  • ADD: Adiciona init()
• 0.1.1
  • CONSERTADO: Crash quando chama baz() (Obrigado @NomeDoContribuidorGeneroso!)
• 0.1.0
  • O primeiro lançamento adequado
  • MUDANÇA: Renomeia foo() para bar()
• 0.0.1
  • Trabalho em andamento

📋 Meta

Seu Nome – Portfólio – [email protected]

Distribuído sob a licença XYZ. Veja LICENSE para mais informações.

https://github.com/seuUsuario/nomeDoRepositorio

🚀 Contribuição

1. Faça o fork do projeto (https://github.com/seuUsuario/nomeDoRepositorio/fork)
2. Crie uma branch para sua modificação (git checkout -b meu-novo-recurso)
3. Faça o commit (git commit -am 'Adicionando um novo recurso...')
4. Push (git push origin meu-novo-recurso)
5. Crie um novo Pull Request