README file generator

Table of Contents

• Description of this project
• How to install this project
• How to use this project
• How to condribute to this project
• Testing
• Questions
• My Github
• Project license

Description

I wanted to create a easy to use application that will not only help you save time when creating a readme file but prompt you to add all basic information that a professional readme file would contain. Hopefully this application will help you put out amazing readme files quickly, giving you more time to code!

Installation

Using this project is quite easy. Once download, in your command line you will do an npm intall followed by running node in the sever.js file.

Usage

Use whenever you want to quickly make a readme!

Contribution Guidelines

Please reach out to me before making any contributions.

Testing

Once everything is downloaded, you can test it in the command line. If it ran successfully it will tell you a readme file has been created. If it ran into any issues it will also tell you so.

Questions

Please feel free to reach out to me at: [email protected]

My GitHub

Link to GitHub: https://github.com/hannahedwards

Walk through video of this application

https://drive.google.com/file/d/1IRxP3910_th9lCvDhoc7aFaRvKzCn1rH/view

License

Do What The F*ck You Want To Public License