cliff-rosenberg / 09-Professional_README_Generator

A Node.js app to produce nicely formatted README.md files for inclusion in Github projects.

Professional README file generator

Licensing:

Link: MIT License

Description:

This application runds in Node to produce nicely formatted README.md files which are then output to a file for inclusion in Github projects.

Installation:

The project needs the Node module 'Inquirer' to function. The module for filesystem functions is built-in to Node and does not require installation.

Screenshot

Link to YouTube video walk-through: 09-Professional_README_Generator video walkthrough

Usage:

After typing 'node index.js' in the command window the user is presented with a series of questions relating to the project. After all questions have been answered then the collected data is formatted and output to a README.md file on the disk.

Contributing:

Contributor Covenant

Testing

No testing is required or included in this setup.

Additional Info:

• Github: cliff-rosenberg
• Email: [e-mail]