Plantilla para crear un README.md formal

README-español.md

Título del Proyecto

Breve descripción del proyecto

Algunos párrafos sobre tu proyecto y el problema que resuelve.

Pre-requisitos

Que cosas necesitas para instalar el software y como instalarlas

Da un ejemplo

Instalación

OS X y Linux:

npm install my-module --save

Windows:

edit autoexec.bat

Ejemplo de uso

Casos de ejemplo sobre cómo utilizar tu proyecto. Algunos bloques de código y capturas de pantalla suelen lucir mejor.

Construido con

Menciona las herramientas que utilizaste para crear tu proyecto

• Dropwizard - El framework web usado
• Maven - Manejador de dependencias
• ROME - Usado para generar RSS

Historial de versiones

• 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
  • CAMBIO: Renombrado foo() a bar()
• 0.0.1
  • Trabajo en progreso

Autores

Menciona a todos aquellos que ayudaron a levantar el proyecto desde sus inicios

• Luis Tapia - Trabajo Inicial - Tapia641
• Fulanito - Documentación - fulanito

Licencia

Este proyecto está bajo la Licencia - mira el archivo LICENSE.md para detalles