Generate professional README.md files from the command line!
Follow prompt to write a README.md like the one below
npm i -g cli-readme-gen
Feel free to clone/fork the repo(make sure you install dependencies)
'fs', 'chalk', 'inquirer'
cli-readme-gen
If you cloned repo start with 'node index.js'
Use to easily create professional looking readme files fast from the command line.
Install in your terminal and if installed globally use 'cli-readme-gen' to run file.
This was originally an assingment from by bootcamp. I've used it for every project and decided to updated it to publish as a package.
npm update -g
-Added color with 'chalk' (2/10/2022)
-Added License badge (2/09/2022)
To help developers quickly write professional README files from the command line/
-NA
This project is covered under MIT.
See License
Copyright <2022> <Keith Murphy>
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.
-Github: https://github.com/KeithMurph
-Email: keithmurphy.dev@gmail.com