Nome do seu projeto

Um resumo curto sobre o que seu projeto faz

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

Instalação

Mac OS X & Linux:

npm install --save

Windows:

edit autoexec.bat

Exemplo de uso

Alguns exemplos que motivariam as pessoas a utilizarem seu projeto ou que demonstrasse que este é útil para alguma coisa. Divida esta parte em partes menores e se possível coloque 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 possasm contribuir com o mesmo. Se possível forneça as informações para diferentes plataformas, exemplo Windows, Linux, Mac OS

Histórico de Atualizações

• 0.2.1

  • CHANGE: Atualização dos docs(o código não foi alterado)

• 0.2.0

  • CHANGE: Removida a função setPadraoXYZ()
  • 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.1.1

  • Projeto Inicial

Meta(Contato)

Seu nome - @SeuTwitter - [email protected]

Distribuído sobre a licença. Veja a Licença para mais informações.

https://github.com/seuusuario/seuprojeto