This easy-to-use command-line-application generates README.md's for you like this one!
All you have to do is add a little bit of information, and you'll receive a professional, easy to read README.md file for your project!
* Clone the repository onto your local machine.
* navigate to your install location in your terminal, then run -- npm i inquirer@8.2.4 -- and -- npm i fs -- to install the required scripts.
* run -- node index.js -- from your terminal
* follow the on-screen prompts, as seen in the screenshots below!
Anyone who routinely has to write READMEs or simply doesn't enjoy working with markdown will appreciate this.
Copyright 2023 corynko
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. -- For More Information, Please Visit https://opensource.org/license/mit/
This project was built by @corynko (Ethan Kotel). If you would like to contribute to this project, please reach out to @corynko.
Please don't hesitate to reach out to me at @corynko or open an issue on my repository (@corynko) with any questions or bugs.
- made using @corynko's readme generator -