kathrynwilkinson / Good-README-Generator

Command-line application that takes in project & developer information and generates a high-quality README for the project, quickly and easily.

Good README Generator

Efficiently generate a high-quality, professional README for any project!

Table of Contents

• Description
• Techologies
• Installation
• Usage
• Contributing
• Contact Me
• License

Description

A quality README with information about a project is important for other developers/users/viewers to know how to view and use your application. This command-line application utilizes Nodejs and Inquirer to generate a README.md file which is populated with your project information. The generator will prompt you for the necessary items, and notify that your README was created when the process is complete.

Technologies

• NodeJS
• Inquirer

Installation

Clone the repository and open it in your preferred code editor. Navigate to the root folder in your command-line and run 'npm i' to install dependencies.

Usage

After installation, run 'node index.js' in the command-line to access the prompts and start the generator. When the prompts are complete, the generator will notify you that your README was created. The file will appear in the application folder with the information you entered.

The README can then be saved, modified, moved, copied, etc. at your liesure!

Contributing

Sole Author: Kathryn Wilkinson

If you have something you'd like to contribute, make a pull request!

Questions?

Please feel free to contact me with any questions via email or LinkedIn.

• Github: kathrynwilkinson
• LinkedIn: kwilkinsonxx
• Email: [e-mail]

License

This project is licensed under the MIT License. For more information, please visit: MIT Explained

© 2021 k.wilkinson