Skip to content

This application will allow a user to create a professional README file from the command line.

Notifications You must be signed in to change notification settings

shelleymcq/README-Generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 

Repository files navigation

README Generator

Licensing:

MIT License

Description

This application will allow a user to create a professional README file from the command line. The inquirer npm package is used to prompt the user for project details and then a README file is generated. In fact, the document you’re reading now was created using this generator!

Table of Contents

Installation

Fork this repo and clone it to your computer. Then install inquirer in the appropriate directory.

Usage

Run node index.js from the command line to initialize the application. Answer each prompt with all the information you wish to include in your README. After answering the prompts, the README file will automatically be generated in the same directory. See the video below for a demonstration.

Demo Video

Links Demo

Questions

To contribute, please contact me by email.

https://github.com/shelleymcq or email me at [email protected]

About

This application will allow a user to create a professional README file from the command line.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published