Docs-generator-readme

Construye tu README simple y rápido para todos tus proyectos ✨

Uso de la dependencia

Instalación:

  npm i docs-generator-readme -g

Nota: se instalará globalmente con -g para que pueda ejecutarse.

---

Uso:

Para ejecutar escibe en la terminal en la ruta de tu proyecto:

  generate-doc

Nota: Si tu proyecto ya tiene un archivo README te preguntará si lo quieres sobrescribir: y/N coloca y(yes) para poder crearte la documentación.

---

Verifica:

Ve al README y comprueba los datos

Nota: agrega el enlace de tu proyecto desplegado(opcional)