README Generator

Github licence

Description

A high-quality README file explains what your application does and why you used the technologies that you did.At a bare minimum, a README needs a title and a short description explaining the what, why, and how of the project.

This is a command-line application that runs with Node.js that dynamically generates a README.md file based on input about your project.

Table of Contents

Installation

The user should clone the repository from GitHub and download Node.Run npm install in order to install the following npm package dependencies such as inquirer in the package.json.

The application will start by running node index.js in the command line.

Answer the prompts in your command line to generate the README.

Usage

Use inquirer from your command line to answer questions about your project.
Or view link here - Screencastify

License

This project is license under MIT

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Tests

npm test

Questions

If you have any questions about this projects, please contact me directly at jingliu788@gmail.com. You can view more of my projects at https://github.com/jing-liu-778.