get-a-readme

Description

This Github repository contains a README generator that simplifies the process of creating professional and informative README files for your projects. The generator is built using Node.js and is customizable, allowing you to include all necessary details about your project such as its purpose, installation instructions, usage examples, and more. The generator is designed to save you time and effort by automating the creation of README files, allowing you to focus on developing your project.

Table of Contents

• Installation
• Usage
• License
• Contributing
• Tests
• Questions

Installation

To install please run

npm i inquirer@8.2.4

Usage

Click here to see a demonstration!

1. Clone this repository to your local machine.
2. Navigate to the develop folder.
3. Run 'node index.js' in terminal.
4. Answer prompts given in terminal.
5. Once complete, find the README in the develop folder.

---

---

License

This project is licensed under the MIT license.

Contributing

You may fork this repository.

Tests

To test please run

N/A

Questions

For additional questions, please contact mwstandish@aol.com.

Follow me on GitHub at MatthewStandish.