https://github.com/dariomvg/docs-generator-readme
Crea la documentación base para tu proyecto
https://github.com/dariomvg/docs-generator-readme
figures fs-extra inquirer javascript nodejs
Last synced: 3 months ago
JSON representation
Crea la documentación base para tu proyecto
- Host: GitHub
- URL: https://github.com/dariomvg/docs-generator-readme
- Owner: dariomvg
- Created: 2025-01-06T21:10:31.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2025-01-06T21:29:43.000Z (5 months ago)
- Last Synced: 2025-01-06T22:30:11.520Z (5 months ago)
- Topics: figures, fs-extra, inquirer, javascript, nodejs
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/docs-generator-readme
- Size: 8.79 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Docs-generator-readme
## Construye tu README simple y rápido para todos tus proyectos ✨
### Uso de la dependencia
#### _Instalación:_
```js
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:
```js
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)