Capricious150 / Professional-Readme-Generator

Uses Node JS and Inquirer to generate a ReadMe Markdown based on user inputs

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ReadMe Generator

License Badge for MIT license

Links & Images

Walkthrough Video on Using this Application

Image of a generated readme Image of some of the prompts used to generate the readme

Description

Generate a professional ReadMe quickly and easily!

Powered by JavaScript, NodeJS, Inquirer, and Shields.io, use the command line to quickly build out the framework and body of a professional ReadMe.

Table of Contents

Installation

Usage

Contributing

Tests

Questions

License

Installation

Clone the repo, and install inquirer using "npm i inquirer" in the terminal. Please reference GitHub and Inquirer's documentation for additional assistance on cloning repositories and installing Inquirer, respectively.

Usage

From the command line run "node index.js" and follow the onscreen prompts. Please reference the linked video at the top of this ReadMe for a more robust walkthrough!

Contributing

Use as you see fit, within the bounds of the MIT license!

Tests

Test as you see fit!

Questions

To view my other repositories or see the repo for this proect, visit my GitHub. To contact me with questions, please email me at austinandrews89@gmail.com

License

This application is covered under the following license: MIT

About

Uses Node JS and Inquirer to generate a ReadMe Markdown based on user inputs


Languages

Language:JavaScript 100.0%