A command line application for developers who don't feel like formatting their readme.md markdown files! Makes use of the inquirer package. Will create readme sections for:
- Title
- Description
- Table of Contents
- Installation
- Usage
- License
- Contribution Guidelines
- Tests
To install, clone this repo to your machine and open a terminal at its directory. To install the proper dependencies, first run npm install.
After installing the package and dependencies, you may run the application by opening a terminal window at the package directory and running npm start.
Follow the prompts. Once all details are entered, a README.md file will be generated in the output folder.
Copyright (c) 2020 Matt Torcellini
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.