This application is a README generator designed to take user input and generate a high-quality README.md document with a table of contents, description, installation, licensing, usage, contribution and contact information. This README generator even created its own README!
This section would contain instructions on installing the application. In this case, you can pull this README-generator from my github repository.
You are free to use this application for any project.
To run this application, use the command node index.js to initialize.
When initialized, the user will be met with a series of prompts for information about their project. Once the user has made all their inputs, the application will automatically write a README.md and save it in the same folder.
If you would like to contribute to this README-Generator, simply create a pull request with your own branch and acomment explaining your contribution's functionality.
To run tests, run the following command:
This section contains test information for your application.
For questions regarding this repo contact me at charlie.bateman117@gmail.com or visit my repository at https://github.com/Clatrobe00
Copyright 2021 undefined
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.