readme-generator-cli v2.0.0
README Generator CLI
Description
This npm package utilizes a Command Line Interface (CLI) application designed to create professional quality README.md documents for projects hosted on Github. Utilizing inquirer and axios, this application generates a markdown file with dynamic data generated from the user's interaction through terminal actioins.
Table of Contents
Installation
This is a CLI avalible through the npm registry.
Before installing, download and install Node.js
Installation is done using the
npm install command
:
$ npm install readme-generator-cli
Usage
After installing in your project directory, simply run
readme-generator-cli
in your terminalFollow all the prompts until the end
A file named "auto-generated-README.md" will be created with all of your responses
Click on the .gif below and watch my tutorial video if you get stuck.
Contributing
Submit a PR and I'll check it out!