Simple README Generator

Description

Generate a standard README markdown file for your project from the command-line.

Table of Contents

• Installation
• Usage
• Reporting issues
• Credits
• License

Installation

Install the necessary dependencies:

npm i

Usage

1. Invoke README Generator using the following command:

node index.js

2. You will then be prompted for information to generate the README for your GitHub online repository via a series of questions that accept user input, including:

• GitHub username

• email address

• title of project
• project description

• license

• command to install any dependencies, npm i by default
• command to run any tests
• usage information

• contributor guidelines

The program then generates a simple README.md file from your input with:

* The title of your project
* Sections entitled:
  * Description
  * Table of Contents
  * Installation
  * Usage
  * License
  * Contributing
  * Tests
  * Questions

3. Finally, find the generated README in the \generated folder

Reporting issues

Suggesting features, improvements, bug fixes

https://github.com/stevelab1/simple-readme-generator/issues

Credits

inquirer

axios

License

This project is licensed under the MIT license.