This is a command line application which dynamically generates a professional ReadMe file with user input. - This ReadMe was made with the application -
1.) Usage
2.) Installation
3.) Credits
4.) Contributing
7.) License
To use this, the application is invoked by the command prompt with --- node index.js fileName
The user is prompted to answer questions to fill in the ReadMe File.
When the user is finished, the application will let the user know if it was a success.
This is an example of a generated ReadMe file.
It includes a badge for the license chosen.
Full Demo
The user will need to have Node.js installed along with the Inquirier and Moment modules.
References were made to www.nodejs.com and www.npmjs.com
Please refer to the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Refer to www.nodejs.com for documentation on the use of Node.js.
Mindy Ratcliff Mindyratcliff mindy.ratcliff@gmail.com
MIT License
Copyright (c) 2020 Mindy Ratcliff
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 PUR POSE 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.