This is a command-line application that helps you generate a professional README.md file for your project. This application is designed to make your life easier by quickly creating a high-quality README file that includes all of the important sections such as Description, Table of Contents, Installation, Usage, License, Contributing, Tests, and Questions.
To install this application, you can clone the GitHub repository and run npm install to install the required dependencies.
To use this application, simply navigate to the root directory of the project in your terminal and run node index.js. You will be prompted to answer a series of questions about your project, such as the project title, description, installation instructions, usage information, contribution guidelines, and test instructions. Once you have answered all of the questions, the application will generate a professional README.md file in the output folder.
This project was created by Ben Antonneau with the help of the following resources:
- Node.js
- Inquirer.js for prompting questions in command line
- Shields.io for generating badges
- Choose a License for providing information about licenses.
No tests are availible for this project.
If you have any questions or issues, feel free to reach out to me via one of the following channels:
Email: benantonn@gmail.com
GitHub: @bantonneau
MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.