README-Generator
README Generator
Description
This project was made to help users create professional README files without having to spend the time to create the formatting.
Table of Contents
Installation
There is no installation process needed for this project. The only requirement is that the user is able to run node.
Usage
The website is live [README-Generator][https://wangbrian26.github.io/README-Generator/]
Navigate to the folder containing the project. Then in the terminal run node index.js to start the project.
If you would like to see a demonstration of this application, please click on this link [Demonstration][https://youtu.be/RCdXR9i8iJM].
You will be asked a series of questions to dynamically render your README file as shown below.
License
MIT License
Copyright (c) [2022] []
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.
Contributions
This project was able to be done through the teachings of Instructor Quinton Fults, TA Takara Truong, and TA Blake Matthews.
Features
Here are some of the highlight features of this application:
This project allows users to pick the license that they want and generates that information at license section. It also generates a badge corresponding to that license at the top of the page.
Tests
Here are some tests that you can run to try out the application:
Users can test using node index.js
Questions
If you have any questions or would like to see any of my other projects, please visit my github:
[Github][https://github.com/wangbrian26]
Please email me at wangbrian26@gmail.com