This is a Readme Generator from a command line input. The objective was to create a professional readme file from input of the key parts of a readme file.
What I learned is how to grab input from a user through command line and take that and write to a readme file. Thorugh the readme generator I deminstrated the use of node js to complete the generator.
To install the Readme generator you have to git clone https://github.com/JaberSE09/Professional-README-Generator.git and run the npm install to get the packages
run node app
First run node app and go through the promts to get the user input and then it creates the readme file in the dist folder
Untitled_.Apr.27.2022.10_18.AM.mp4
The video askes for: -Title -Description -Install instructions -Usage -Credits -License -Tests -Github Username -Email
Then puts it all in README.md in the dist folder
Sajid Jaber
MIT License
Copyright (c) [2022] [Sajid Jaber]
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.
Table of content