Skip to content

prompt-based automatic readme generator for programming projects using Node.js

Notifications You must be signed in to change notification settings

SlaterMcArdle/Node_ReadMe_Generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Node ReadMe Generator

License

Table of Contents

Description

This project's goal was to create a command line based readme generator using node.js. It utilized the inquirer and filesystem packages. It asks the user to input info for all of the relevant sections, then creates a template literal with the markdown. It writes the markdown template string into a readme file.

Find a walkthrough video here

Installation Instructions

Fork it from my github. Find the link at the bottom of this readme.

Usage Instructions

run the following command: node index.js

Contribution Instructions

Do not contribute. The project is finished.

Testing Instructions

You break it, you buy it.

License

MIT

Questions

Check out my Github

Or email me

About

prompt-based automatic readme generator for programming projects using Node.js

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published