When creating an open source project on GitHub, it’s important to have a high-quality README for the app. The README should answer these questions:
- What the app is for?
- How to use the app?
- How to install it?
- How to report issues?
- How to make contributions?
This applications is a command-line application that is used to generate a README file. This will provide the developer more time to focus on development, rather than docummentation.
README Generator will dynamically generate a README.md file, based on user input from the command-line.
User input will be collected using the Inquirer package, and the Professional README Guide is the guide for a high-quality, professional README file.
-
The application will be invoked by using the following command:
npm run dev
-
Video that demonstrates its functionality.
-
Screenshots: :::image type="content" source="./assets/images/screenshot1.png" alt-text="screenshot 1"::: :::image type="content" source="./assets/images/screenshot2.png" alt-text="screenshot 2"::: :::image type="content" source="./assets/images/screenshot3.png" alt-text="screenshot 3"::: :::image type="content" source="./assets/images/screenshot4.png" alt-text="screenshot 4":::