Efficient-README-Generator

Username:

kaitekelly 👩🏻‍💻

Title:

Efficient README Generator

Description:

💻 A command line README generator for quick, efficient project README’s.

Table of Contents: n/a

Installation:

💾 User will need to install Node.js on their computer. Once that is installed, cd into your project folder and type npm install into the working directory to install dependencies. User will also need to install npm file system and npm inquirer.

Usage:

⚙️ In Terminal, cd into this project directory. Type node index.js into the command line. User will presented with a series of question prompts to fill in the README information. User should include as much information as possible. At the completion of the questions, a readme markdown file will be generated with all of the information the user entered. This will also include a clickable badge that once clicked, will redirect to the developer’s github page.

Screenshot of command line questions and answers:

Screenshot of generated README for Weather Dashboard:

Link to user demo video: https://drive.google.com/file/d/1sqktpDrc4HR1iAnUprvLiRUdKaD8iswR/view

Contribute:

Contributor: Kaite Kelly. NPM’s used: Inquirer, File System, sheild.co for badge.

Tests:

No tests have been written for this application.

License:

ISC