jeverett93/readmegenerator

This is a command-line application that dynamically generates a README based on user input.

Readme Generator

Description

This is a command-line application that dynamically generates a README.md from a user's input.

Table of Contents

• Description
• Installation
• Technology Stack
• Usage
• Contributors
• Contact
• Tests

Installation

• Step 1. Git clone this link to your terminal: https://github.com/jeverett93/readmegenerator.git

• Step 2. Navigate into the cloned repository.

• Step 3. Install the axios, dotenv, and inquirer dependencies into your command line using the following commands respectively:

  npm install axios
  npm install dotenv
  npm install inquirer
  

• Step 4. Run the application from the command line with following command:

  node index.js
  

Technology Stack

Node.Js, JavaScript, GIT, GitHub, HTML, CSS, APIs, Command- Line

Usage

AS A developer

I WANT a README generator

SO THAT I can easily put together a good README for a new project

Contributors

github.com/jeverett93

Contact

• Name: Joshua Everett

• Portfolio: jeverett.github.io

• Email: josheverett93@gmail.com

• LinkedIn: https://www.linkedin.com/in/joshua-everett-087a4649/

Tests

To run tests run:

npm run test