vanessalane / readme-generator

A Node CLI app that generates READMEs for new projects

README Generator

Description

A Node app that generates README files for new projects.

Information included in the README.md file:

• Description
• Table of Contents
• Installation
• Usage
• License
• Contribution Guidelines
• How to Test
• Questions

User Story

As a developer, I want a README generator so that I can quickly create a professional README for a new project.

Usage

1. Clone the repo
2. Run npm -i to install dependencies
3. Run node index to run the app
4. Answer prompts and check out your README!

Packages

• Inquirer

Questions

If you have questions, email me at [e-mail] or reach out on GitHub.

Screen Recordings