Skip to content

Latest commit

 

History

History
62 lines (38 loc) · 1.88 KB

README.md

File metadata and controls

62 lines (38 loc) · 1.88 KB

Professional-README-Generator License: Unlicense

Description

This is a README generator that uses the command line interface. It uses the inquirer npm package to ask the user about the important aspects of their project, then using the responses by user, creates a README in a markdown format.

The program is able to generate with the following sections so far: description, table of contents, installation (optional), usage (optional), contributing (optional), tests (optional), questions, and license.

Repository / Deployment

The repository is located here.

Table of Contents

Visuals

Please view my video demonstration of the program here.

bash1 bash2 md1 md2

Installation

npm i

Usage

node index

Questions

Please refer to my Github.

Also contact me via email with your inquiries.

Credits

Here are some references I used that helped me create this:

University of Washington Full Stack Web Development Program's Good README Guide

(https://choosealicense.com)

(https://stackoverflow.com/questions/9628879/javascript-regex-username-validation)

(https://stackoverflow.com/questions/65189877/how-can-i-validate-that-a-user-input-their-email-when-using-inquirer-npm/65190734#65190734)

License

This project is under The Unlicense.