Skip to content

Auto-generate a professional project readme with this terminal app. ๐Ÿ“ƒ

Notifications You must be signed in to change notification settings

vlsulliv/readme-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

6 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Readme Generator

MIT GIT
MIT license MIT license

Table of Contents

Readme Generator
License
Description
Usage
Technologies
Contact Me

Description

Readme Generator is a command line application that generates a project readme based on user input. After `node index.js` is executed, the user is prompted to answer a sequence of question about the project. When questions are complete, a readme is generated and will appear in the root directory - filename: ```readme.md```

Stretch: Design a polished UI with the chalk package. It is downloaded and imported but not called at the moment.

Usage

To use the app:
  1. Open a terminal.
  2. Navigate to root of project folder.
  3. Use command `node index.js`
  4. Answer prompt inquires

Technologies

  1. MomentJS
  2. HTML
  3. CSS
  4. Javascript
  4. NodeJS
  5. Inquirer

Contact Me

Email
Slack
linkedIn
GitHub


Project By: Vincent Sullivan โœŒ๏ธ๐Ÿข

About

Auto-generate a professional project readme with this terminal app. ๐Ÿ“ƒ

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published