📜 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.
OS X & Linux:
npm install my-crazy-module --save
Windows:
edit autoexec.bat
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.
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
- 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()
- MUDANÇA: Remove
- 0.1.1
- CONSERTADO: Crash quando chama
baz()
(Obrigado @NomeDoContribuidorGeneroso!)
- CONSERTADO: Crash quando chama
- 0.1.0
- O primeiro lançamento adequado
- MUDANÇA: Renomeia
foo()
parabar()
- 0.0.1
- Trabalho em andamento
Seu Nome – @SeuNome – [email protected]
Distribuído sob a licença XYZ. Veja LICENSE
para mais informações.
https://github.com/seuprojeto/github-link
- Faça o fork do projeto (https://github.com/seunome/seuprojeto/fork)
- Crie uma branch para sua modificação (
git checkout -b feature/fooBar
) - Faça o commit (
git commit -am 'Add some fooBar'
) - Push (
git push origin feature/fooBar
) - Crie um novo Pull Request