/generate_readMe

Primary LanguageJavaScript

09 Node.js: Professional README Generator

Description

This project focuses on making README files easy to create while keeping them professional. This will give you the oportunity to devote most of your time and effort to your project instead. This README generator gives you options to include the following information:

  • Title
  • Description
  • Installation
  • Usage
  • Contributing
  • How to invoke the application
  • License
  • GitHub username
  • Email

The provided table of contents is set up to where they link to the corresponding section.

Installation Requirements

  • Node.js
  • inquirer (can be downloaded after cloning this repo by typing npm install)

Usage

WHEN I am prompted to input my gitHub username
THEN I am provided a generated README containing a link to my gitHub profile

Test

The application will be invoked by using the following command:

node index.js

Demo

README

View a walk through demonstration video here.

Contributors

Shelsy Barrera