ReadMe Generator is a CLI application for users that need to quickly create a professional README so that they can primarily focus on development. This application allows users to input information they want included on the README including title, description, installation instructions, usage information, test instructions, contribution guidelines, license, and question section for the user's github profile and email. Once the user inputs their information the application then generates a markdown file. The application was developed using Node.js
To use the ReadMe_Generator, install Node.js on your computer. Run the command 'node index.js'. Provide answers to the prompts and once completed a markdown file will be generated.
Visit my GitHub Profile
For additional questions, contact me by email at raiford87@gmail.com.
MIT License
Copyright (c) [2020] [Rashawn Raiford]
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.