Professional-README-Generator

Table of Contents

• Overview
• Why are Professional README Markdown Files Important?
• Technologies Used
• Screen Capture
• Full Walkthrough Video
• Installation
• Usage

Overview

This repository is an exhibition of a professional README generator. The user can consult the repo to learn how to create a command-line application that dynamically generates a professional README.md file from a user's input using the Inquirer Package.

Why are Professional README Markdown Files Important?

When creating an open source project on GitHub, it’s important to have a high-quality README for the app. This should include what the app is for, how to use the app, how to install it, how to report issues, and how to make contributions—this last part increases the likelihood that other developers will contribute to the success of the project.

Technologies Used

                                   

Screen Capture

Full Walkthrough Video

Link

Installation

1. Fork and clone repository to local machine.
2. Run npm i to install dependencies in local project directory.

Usage

1. Open integrated terminal in personal IDE.
2. Run node index.js.
3. Answer the prompts that follow.
4. A sampleREADME.md will be generated and stored in "utils" folder.