markdown-readme-generator
v1.0.0
Published
A professional README generator for all your projects
Downloads
2
Maintainers
Readme
Markdown README Generator
Table of Contents
Description
The what, why, and how:
When creating an open source project on GitHub, it’s important to have a high-quality README for the app. This should include what the app is for, how to use the app, how to install it, how to report issues, and how to make contributions—this last part increases the likelihood that other developers will contribute to the success of the project.
Installation
npm install
Usage
When you run node index.js, the application uses the inquirer package to prompt you in the command line with a series of questions about your GitHub and about your project. From there, the application will generate markdown and a table of contents for the README conditionally based on your responses to the Inquirer prompts (so, if you don't answer the optional questions, such as Installation, an Installation section will not be included in your README). The README will also include badges for the licenses.
Test
npm run test
Contribution
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
License
This project is licensed under The MIT License
Demo
Demo link for this project
https://bootcampspot.instructuremedia.com/embed/9d25e73c-dac5-4a1e-bb58-eef04731166a
Questions
If you have any questions about your repo, open an issue or contact me directly at [email protected]. You can find more of my work at @sploganathan