Skip to content

LauraCole1900/nodeREADMEGenerator

Repository files navigation

Good README.md Generator

Table of Contents

Description

This is a README generator using Node.js. The user enters through the terminal and first drills down into the containing folder, then enters "node index.js" into the command line. They are then taken through a series of prompts eliciting the necessary information about their project, which the generator then synthesizes into a README.md file.

Links

Link to walkthrough video

Installation Instructions

If you want to run a copy of this app on your local machine, first clone the repository:

HTTPS:

$ git clone https://github.com/LauraCole1900/expressNoteTaker.git

SSH:

$ git clone git@github.com:LauraCole1900/nodeREADMEGenerator.git

Then cd/ into the cloned directory and start the application by typing into the command line

$ node index.js

Usage

This project generates README.md files.

Technologies Used

Node.js Inquirer.js

Tests

npm run test

Credits

N/A

Contributing

We believe code is never finished, welcome your contributions to enhance the applications functionality. Please adhere to the Code of Conduct for the Contributor Covenant, version 2.0, at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Questions

If you have further questions, you can reach me at lauracole1900@comcast.net. For more of my work, see my GitHub.

Badges

License badge Open in Visual Studio Code