/readme-generator

Primary LanguageJavaScriptMIT LicenseMIT

README Generator

License

License: MIT

Description

This is a command-line application that generates a professional README. Using prompts in the terminal, the README generator creates a README from user input that includes a title, as well as sections for a description, table of contents, installation, usage, demo, contributors, and tests.

AS A developer
I WANT a README generator
SO THAT can quickly create a professional README for a new project

Screenshots

Screenshot of Terminal

Screenshot of README

Table of contents

Installation

In the command line, run:

* require node.js
* npm init -y
* npm install inquirer

Usage

In your command line, run node index and follow the prompts to generate a README within node.

Demo

animated demo of app

Contributors

Please contribute to this code.

Test

N/A

Repository