Revisión de documentación

[arielatolosasilva]

Este issue forma parte del proceso de revisión del Laboratoria Code Squads Noviembre 2020 de la iniciativa Código para el Desarrollo de @EL-BID

Issue de revisión de documentación - readme.md:

Al haber contrastado la información presentadas en el repo oficial con los campos solicitados en la plantilla de readme.md hemos encontrado los siguiente puntos a mejorar:

• Agregar el logo para identificar el proyecto.
• Agregar una imagen o gif del proyecto para identificar su funcionalidad principal.
• Incluir badges con el estado de desarrollo, licencia, versión, coverage, sociales u otras.
• Proporcionar una tabla de contenidos con links para cada apartado para que funcione como índice.
• Especificar los pre-requisitos necesarios para ejecutar el proyecto (environment, librerías, dependencias, entre otros), y proporcionar comandos de instalación de los mismos.
• Precisar si se requieren variables de entorno y en qué parte de la arquitectura se colocan.
• Añadir una serie de pasos que permitan la instalación y uso del proyecto de forma local.
• Añadir comando de ejecución para pruebas unitarias.
• Hacer mención de las tecnologías utilizadas y añadir enlaces haciendo referencia a la documentación de cada una.
• Si es preciso, añadir fragmentos de código con ejemplos de uso.
• Añadir sección autor@s.
• Añadir un apartado con el proceso detallado para contribuir al proyecto.
• Añadir un apartado especificando la licencia open source que se esté usando redirigiendo al archivo LICENSE.md.