This is a command line interface application which creates a README file for your application repositories. This will allow people to understand how your app works, how to install it, and how other developers can contribute to your project. This README.md is being created via this system.
You can access more badges and their purposes at shields.io
Follow these steps to properly install this application:
To install this app you will need to run npm install for the following dependencies in your CLI, inquirer, fs, and util. This will allow the question prompts from the CLI for you to create your README.md.
Instructions for use:
Run the command node index.js in the CLI and the inquirer package will begin prompts for your README section information. As you answer each question you dynamically form the sections, and table of contents for your README.
All the responses are converted to markdown format and the fs.write package will create the README.md file automatically upon completing the prompts.
Here is an MP4 showing the entire process that can be watched through the Awesome Screenshot link below.
For further questions:
If you have any questions, or additional feedback, please feel free to email me and I will respond as soon as possible.
Contact Info:
GitHub: JohnBanas
Email: jbanas9124@gmail.com
This application has the MIT License.
For more information please view the license description.
Xandromus Xander Rapstine
gchoi2u
Original Source Code: https://github.com/coding-boot-camp/potential-enigma
How to create a Professional README