/Gen_ReadMe

Ever needed a quick Readme.md generator for your projects? Look no further.

Primary LanguageJavaScript

Gen_Readme License: MIT

Description:

This project is a README.md generator. It will take the user input of name, description, license and other things to then generate a Readme.md using this information. This generator makes use of inquirer NPM package. While not perfect, it makes a great start to any project Readme. The user input is taken through the command line using node.js. Please see video for a walkthrough on functionality. An example has also been included in repo under GenReadMe_Example.md.

Table of Contents:

Installation

Download the repo. Make sure to also install the inquirer package using "npm i".  

Usage

It is intialized using "node index.js".

License:

This project is covered under the following license. See link for more information. If empty, no license is being used.

MIT
https://opensource.org/licenses/MIT

Contributors:

If you have any suggestions or ideas for improvement, please do not hesistate to fork and create a pull request to be reviewed by myself. 

If you would like to contribute please follow:

The sky's the limit. Just please fork and submit pull request.

Test Instructions:

None at this moment.

Website:

Github Repository: https://github.com/PRicoSaint/Gen_ReadMe

Screenshot:

Gen_Readme

Please see GenReadMe_Example.md for an example of README.md created using this code.

Technologies-Used:

HTML
CSS
Javascript
node.js

Any questions/suggestions/critique?

Please find me at: https://github.com/PRicoSaint/

I can be contacted through email: santosesteban09@gmail.com