cynthiagodoy / node-readme-generator

Node.js, Command Line Interface (Inquirer)

Node.js, CLI: Professional README Generator

Project Description

To create a command-line application that dynamically generates a professional sampleREADME.md file from a user's input using the Inquirer package. To install inquirer use the following command in the terminal:

npm i inquirer

Main Objective | How to Use

The application will be invoked by using the following command in bash:

node index.js

Items Completed in Project

✅When prompted for information, a high quality sampleREADME.md is generated based on the user input.

✅The sampleREADME will include: Description, Installation Instructions, Usage Information, Contribution Guidelines, and Test Instructions.

✅The badge for the license will be added near the top of the sampleREADME.md along with a section which explains what the license is. Badge is clickable and directs user to the detailed license page.

✅The Question section will include: GitHub Username with link, Email address, and/or any additional ways to reach the creator.

✅When the Table of Contents section is clicked, then you are taken to the corresponding section of the README.

✅Repo includes .gitignore file and include node_modules/ and .DS_Store/ so that node_modules directory isn't tracked or uploaded to GitHub. Be sure to create your .gitignore file before installing any npm dependencies.

✅Repo includes a package.json with the required dependencies created by running npm init.

✅Used license-badges.md

Walkthrough Video

• A walkthrough video that demonstrates the functionality of the README generator.

View on Google Drive

Screenshot

---