Breve descripción de lo que hace tu producto.

Uno o dos párrafos sobre tu producto y el problema que resuelve.

OS X y Linux:

npm install my-crazy-module --save

Windows:

edit autoexec.bat

Algunos casos de ejemplo sobre cómo utilizar tu producto. Algunos bloques de código y capturas de pantalla harán que sea más atractivo.

Describe como instalar todas las dependencias y como ejecutar la batería de tests (en caso de tenerla). Si funciona en múltiples plataformas intenta describirlas todas si tuviesen pasos diferentes.

make install
npm test

• 0.2.1
  • CAMBIO: Actualizada la documentación (el módulo de código permanece igual)
• 0.2.0
  • CAMBIO: Eliminado setDefaultXYZ()
  • AÑADIDO: Añadido init()
• 0.1.1
  • ARREGLADO: Cuelgue cuando se llama a baz() (Gracias a @NombreDelAmableContribuidor!)
• 0.1.0
  • La primera release
  • CAMBIO: Renombrado foo() a bar()
• 0.0.1
  • Trabajo en progreso

Tu nomre – @TuTwitter – [email protected]

Distribuido bajo la licencia XYZ. Ver LICENSE para más información.

https://github.com/yourname/github-link