This application helps you to save time with your README documentation leaving you with more time to focus on your project.
To install necessary dependencies, run the following command:
npm i inquirer
To start, run on your command line node index.js, this will prompt a series of questions that will be used to build your README. The title of your project is going to be used as your README file name, as well as the title of the README. You are going to be requested to enter your application description, installation instructions, usage, license, contribution information, tests and contact information as GitHub username and email. There are five options of license to choose from MIT, APACHE 2.0, GPL 3.0, BSD 3 or None, you can use your keyboard arrows to chose one, then press enter. This README has been created using this application. Click on the gif below to watch a video showing this creation.
This project is licensed under the terms of the MIT license.
If you would like to participate on this project please submit any bugs or feature requests to the contact listed on the questions section of this README.
To run tests, run the following command:
node index.js
If you have any questions about the repo, open an issue or contact me directly at camila.alves85@gmail.com. You can find more of my work at Mimila-85.