/readme-generator

Smart readme generator using node.js + inquirer NPM package

Primary LanguageJavaScriptMIT LicenseMIT

README Generator

license

Description

This is a readme generator to make it easier for users to make their readmes from scratch. It uses node.js and the inquirer package. Check the file called "README - sample unedited.MD" for a sample of what the output looks like.

Table of Contents

Installation

Run the following code to install dependencies:

    npm install

Usage

Click HERE for a video walkthrough

  1. Git clone this to your local machine and install per the above instructions
  2. Ensure you have a license in your repo before creating the readme as the badge is generated from there. See here for a quick guide.
  3. Type node index in the terminal after navigating to the file
  4. Answer all of the questions
  5. A file called README.MD will be generated and a "File created!" message will pop up in the terminal

License

This project uses MIT license.

Contributing

I'd love ideas on how to improve this. Email rpgarde@gmail.com if you want to contribute anything!

Tests

No tests installed on this repo.

Questions

For any further questions, reach out to rpgarde@gmail.com or visit my Github profile.