This is a README generator using Node.js, Inquirer.js, and Fs (File System). This README is designed to help ease the process of writing READMEs for projects. It even gets generated right into the directory you are currently in! While constructing this project, I was able to get to practice coding in ES6 by using things like template literals and arrow functions. I was also able to familiarize myself with Inquirer.js, Fs, and Markdown.
- [Installation] (#installation)
- [Usage] (#usage)
- [Contributing] (#contributing)
- [Tests] (#tests)
- [Questions] (#questions)
To install this project, run node index.
To use this project, simply answer the questions that are prompted in your command line after running node index. Watch as a Markdown file gets generated in the same directory you are currently in.
Please see the Contributor Covenant (https://www.contributor-covenant.org/)
No
The MIT License: "A short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code." (https://choosealicense.com/licenses/mit/)
The GNU GPLv3 License: "Permissions of this strong copyleft license are conditioned on making available complete source code of licensed works and modifications, which include larger works using a licensed work, under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights." (https://choosealicense.com/licenses/gpl-3.0/)
The ISC License: "A permissive license lets people do anything with your code with proper attribution and without warranty. The ISC license is functionally equivalent to the BSD 2-Clause and MIT licenses, removing some language that is no longer necessary." (https://choosealicense.com/licenses/isc/)