Nome do seu projeto

Um resumo curto sobre o que o seu projeto faz

Um ou dois parágrafos sobre o seu projeto e o que ele faz.

Instalação

OS X & Linux:

npm install --save

Windows

cmd autoexec.bat

Exemplo de uso

Alguns exemplos que motivariam as pessoas a utilizarem seu projeto ou que demonstrasse que este é útil para alguma coisa. Digida esta parte em partes menores e se possível cooque algum código ou prints de telas.

Ambiente de Desenvolvimento

Descrever como instalar e preparar qualquer dependência de desenvolvimento para que seu projeto possa ser executado localmente e pessoas possam contribuir com o mesmo. Se possivel fornceças as informações para diferentes plataformas, exemplo Windwos, Linux e Mac OS.

Histórico de atualizações

• 0.2.1
  • CHANGE: Atualizações dos docs(o código não foi alterado)
• 0.2.0
  • CHANGE: Removida a função ´sePadraoXYZ()´
  • ADD: Adicionado a função inicializar()
• 0.1.1
  • FIX: Crash quando executava escrever (obrigado ao contribuidor)
• 0.1.0
  • O primeiro lançamento estável
  • CHANGE: Renomeado de Projeto XYZ para Projeto ABC
• 0.0.1
  • Projeto inicial

Meta

Seu nome - @SeuTwitter - [email protected]

Distribuido sobre a licença. Veja LICENÇA para mais informações.

https://github.com/seuusuario/seuprojeto