Link to the deployed website repository can be viewed here: Read Me Generator
This project aims to create an instant template for README.md for developers in an easy manner
To install the files into your local repo, using Git Bash Terminal:
- Create a folder locally to nominate for cloning from online repo
- Clone with SSH by
git clone git@github.com:leonhsu95/readme-generator.git"
Additionally, please install node.js and install the inquirer package in your terminal with
npm i init
npm i inquirer
The project should look like this:
A Video Demonstration can be viewed here: Demo
Usage of this project is subject to the below license.
Copyright 2021 © Leon Hsu leonhsu95. All rights reserved. Licensed under the MIT.
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.
- The software takes user inputs and information is written and saved into the markdown file.
- There is input validation for regular inputs and an email regex is used for email validation.
This project can be tested with JS Validation Service. The Inquirer Package can tested further, please refer to documentation at npm Inquirer.