Every good project requires a professional looking README file to let everyone know what your project is and how to use it. This is a Command Line (CLI) application that runs with Node.js that dynamically generates a README.md file based on input about your project.
To install the README Generator, 'Git Clone' the repo to a local instance.
In your terminal ensure you are in the appropriate directory and run 'npm install' from the CLI which will install 'Inquirer' which is specified from the dependencies in the 'package.json' file.
To start the application type 'node index.js' in the command line.
Answer the prompts in your command line to generate the README.
After answering all the prompts, your README file will be named 'NewREADME.md' and will be ready for you in the util folder.
The README will automatically generate a the appropriate license badges for the license that you selected as well as generate a link to the appropriate license site. The README will generate under the Questions heading the email and GitHub username that you input at the prompts.
This project does not have a license attached.
Collaborators
N/A
Any questions regarding this project can be directed to:
Github username. MSchuur