Skip to content

Latest commit

 

History

History
30 lines (24 loc) · 1.16 KB

ReadMe.md

File metadata and controls

30 lines (24 loc) · 1.16 KB

README Generator

Description

This application generates a professional README based on user criteria from the command line.

Table of Contents

Installation

To install necessary dependencies, run the following command:

>npm i

Usage

Run node index.js from the command line to launch application. A video demonstration of the application working can be found at (https://github.com/erasersleeve/README-Generator/blob/master/assets/video_demonstration.webm), and screenshots are also available at (https://github.com/erasersleeve/README-Generator/tree/master/assets/images).

License

None

Contributing

Please make a pull request or contact me directly (contact information available below).

Tests

To run tests, run the following command:

>npm test

Questions

If you have any questions about this repo, open an issue or contact me directly at tim@email.com. You can find more of my work at (https://github.com/erasersleeve).