Professional Readme Generator 💻

📖 Table of Contents :

Click to see Contents

Description
User Story
Preview
Installation
Usage Information
Test
Badges
RogueStorm7-livesite

Description :

🗺️ This README.md Generator is a Node.js application that will help the user generate a professional README.md. file. There are a few things that should be included in a professional high quality README.md are the following: what the app is for, how to install it, how to make contributions; which allows other developers to contribute to the success of the project, and lastly, how to report an issue which is possible through testing. The information needed to help the user understand the project is vital so a good description and outline for them to follow makes that possible.

User Story

WHEN I am prompted for information about my application repository THEN a high-quality, professional README.md is generated with the title of my project and sections entitled Description, Table of Contents, Installation, Usage, License, Contributing, Tests, and Questions WHEN I enter my project title THEN this is displayed as the title of the README WHEN I enter a description, installation instructions, usage information, contribution guidelines, and test instructions THEN this information is added to the sections of the README entitled Description, Installation, Usage, License, Contributing, and Tests WHEN I choose a license for my application from a list of options THEN a badge for that license is added near the top of the README and a notice is added to the section of the README entitled License that explains which license the application is covered under WHEN I enter my GitHub username THEN this is added to the section of the README entitled Questions, with a link to my GitHub profile WHEN I enter my email address THEN this is added to the section of the README entitled Questions, with instructions on how to reach me with additional questions WHEN I click on the links in the Table of Contents THEN I am taken to the corresponding section of the README

Preview:

Demo📷
Screenshot

Installation:

Pre-install npm inquirer
Clone-Repo🧭

Usage Information:

Open terminal
Type 'node index.js'
Answer the prompts that follow
Once completed a README.md will be generated. 🪄 Ta-da ✨magic✨!

Test

If there are additional changes you would like to make feel free to type in index.js and make changes until you have something you are satisfied with.