Skip to content

CLI to auto-generate a README.md for a user's repository containing the following areas: title, license banner, description, table of contents, installation, usage, license, contributors, tests, and contact information.

License

Notifications You must be signed in to change notification settings

jtbataille/README-Generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

README.md Generator

License: MIT

Table of Contents

Description

The user of this program will be provided with a CLI using inquirer in order to generate a dynamically-created README.md file. These command-line prompts will obtain the necessary information for a professional README.md file and subsequently create this file for the user's project, program, or application.

Installation

As a user, you will need to install the following packages: inquirer

Usage

To run, a user should clone this GitHub repository, open an integrated terminal--or a general terminal within the appropriate directory--, and enter the command

node index.js

Upon entering this command-line text, the user should answer each of the prompts as these are the answers this program will use to dynamically create the README.md file for the user's purposes.

Technologies Used

Node JS, JavaScript, Inquirer

Tests

In order to test this program, use the following command:

node index.js

Application Demo

Contact Information

About

CLI to auto-generate a README.md for a user's repository containing the following areas: title, license banner, description, table of contents, installation, usage, license, contributors, tests, and contact information.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published