- Questions
- Description
- Installation
- Usage
- Technologies and Programs Used
- Demonstration
- Tests
- Links
- Credits
- License
By Sfzmango
Email: maunghtike1999@gmail.com
This is a program constructed with Javascript and utilizes Node.js. It features usage of the Inquirer and Node-fetch packages to create a nicely formatted README generator based on user inputs. Who would this program be suited for? This program is available for interested parties who are looking to be able to create their README files very quickly all while being formatted neatly. Tired of guessing what to write down on your README file? Load up the program and you'll be making a READEME just like the one you are reading right now in no time!
Please download all the files included in the repository. Afterwards, please open your terminal into the repository folder and utilize Node.js's npm install feature to install Inquirer and Node-fetch.
npm i inquirer
npm i node-fetch
To start the program, please open the perfect-readme directory on terminal and type in node index.js. You will be prompted to enter your desired inputs for specific sections for the README files.
- Javascript
- Node.js
- VS Code
- Git/Github
No known bugs.
Special Thanks to:
Maung Htike
MIT License
Copyright (c) 2022 Maung Htike
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.