This project aims to make your documentation's write faster, at an "developer's hands distance", it can use an readme's template to generate yours for every new project by just input the fields, then it will be further changed with your inputs.

At the current stage, 23/05/2022, you only has one template at your disposal, but with the soon-to-be expansion of the reserved keywords you can create how many templates you wish.

That is a possibility of change some interactivity at some steps during updates. At this moment I'm not aiming for full fledge cli program, but I think if I keep have ideas and others too it might grow to it.

This README.md was firstly generated with this.

| Technologies | |:---:| | Javascript | | Node.js |

At this moment, this program will only work when run at an interactive shell

At this moment, it's advised to install at the global modules, this way you can run the aliases at every project folder, regardless of the dependencies being installed at your currently project.

npm i @yuricss/cli-readme-file-creator -g

readme

But, even so you feel like this wouldn't be worth and just want to try it follow bellow.

npm i @yuricss/cli-readme-file-creator --save-dev

npx @yuricss/cli-readme-file-creator

1. When the question shows up answer it with the instructions showed in windows

2. You can rather pick the an Lorem Ipsum of ~130 letters or Writing you own Description.

3. During the step of selecting the technologies you can search by writing the name of it, there is 32 languages, frameworks and tools at this moment.

4. At least the license, at this moment, there is only MIT available, it will pick the project's name and author in package.json.

MIT License

Copyright (c) 2022 Yuri Cruz Soares da Silva