Command-line application for quick and easy README files to get started.
MIT
Node.js Command-line application for quick and easy README files to get started. Save your time!
This Node.js application can be used by any one who would like to save time and still have a good README baseline that complies with the most used guidelines on making .md files.
a command line prompt will guide the user through a series of questions directed to auto populate the README.md file once all the questions of the prompt are done.
-
Here it is an example of the questions prompted when the application is started:
-
This is an example of the written file once the program is completed.
The application requires inquirer and util node packages.
Run npm install inquirer and npm install util before executing node index.js
View a video demonstration of the application:https://www.youtube.com/watch?v=sxGx_7dFJ_c&feature=youtu.be
I have used the MIT license for this application see repository documentation https://github.com/MattCross01/Professional-README-Generator/blob/master/LICENSE
This can be manually tested or using any test tool
Please contact me at my e-mail: mountaindew2141@outlook.com
Follow me on Github https://github.com/MattCross01