Professional Readme Generator

Description

Welcome to the Professional README Generator!

This command line application dynamically generates a README.md file based on the user's input. This allows the user to quickly and easily generate README.md files.

Table of Contents

• Installation
• Usage
• Tech
• Contribution
• Tests
• Questions
• License

Installation

1. Clone or download the files from this repository.
2. Node.js must be installed to use this application.
3. After you install Node.js, verify NPM installation npm -v
4. Install the inquirer third party module npm install inquirer@^8.2.4

Usage

1. In the command line, invoke the application node index.js
2. The application will prompt the user with questions to complete the README.md
3. After answering the questions, a README file will be created with the user's input. The image below is an example of a README.md generated by the application.

Tech

Node.js was implemented to help create this generator.

Demo

Video demonstration of command line application

Contribution

University of Central Florida Coding Bootcamp

Questions

• Checkout my GitHub profile

• Any additional questions or feed back, feel free to send an email.

License

Copyright (c) bethdecarlo. All rights reserved.

Licensed under the MIT license.