Skip to content

This node js project allows for clients to create their own custom ReadMe file that includes all the major information required for a proper ReadMe file.

Notifications You must be signed in to change notification settings

VSLG2020/ReadMeGenerator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

** Developer Story **

This is a command-line application that accepts user input

-WHEN prompted for information about my application repository a high-quality, professional README is generated with the title of the project and sections entitled; Description, Table of Contents, Installation, Usage, License, Contributing, Tests, and Languages. -WHEN project title is entered this is displayed as the title of the README

-WHEN a [description, installation instructions, usage information, contribution guidelines, and test instructions] is entererd, this information is added to the sections of the README entitled Description, Installation, Usage, Contributing, and Tests

WHEN choosing a license for the application a list of options is presented. followed by a badge

WHEN github, email or Url Links are presented you are able to follow the link.

The new README file is generated in its perspective folder (ie: the utils/dist)

https://github.com/VSLG2020/ReadMeGenerator.git Repository Link

https://github.com/VSLG2020 Github Link

VIDEO RECORDING OF FUNCTIONALITY https://drive.google.com/file/d/1ku0sWZ5yK-NBTa0jBl4i8GsOLVHuMiIB/view

About

This node js project allows for clients to create their own custom ReadMe file that includes all the major information required for a proper ReadMe file.

Resources

Stars

Watchers

Forks

Packages

No packages published