Skip to content

awil414/Command-Line-README-Generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Command Line README Generator

License: MIT

Description

A quality README offers developers the opportunity to explain and showcase what their application does, highlights technologies used, and allows insight on future implementations. With this professional README generator the user no longer needs to create one from scratch, allowing for more efficient use of time. Simply answer a few prompt questions from the command line, and the README will self-generate.

Table of Contents

"https://choosealicense.com/licenses/"

Installation

To install necessary dependencies, run the following command:

To initialize this project, copy the repo SSH key, clone it into your repo, and install Node Package Manager using "npm init -y". Next, use command "npm install --save inquirer@^8.0.0" to get npm's inquirer package.

Usage

Once software is downloaded and Node packages are initialized, run node index.js in your command line. A series of prompts will appear. From here, simply input the necessary information for you project. Upon completion, a new README file will generate. See demo here: https://watch.screencastify.com/v/N6ZTDjP8E6PJss7xDhiD

License

This project is licensed under the MIT license.

Credits

This project was developed by Amber Wilson.

Tests

To run tests, run the following command:

Add commands to run tests here.

Questions

If you have any questions about the repo, contact me at awil414@gmail.com. You can find more of my work at awil414.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published