Gimme Readme

A Dynamic README Generator

We all know how painstaking writing README files can be. Forgetting important details, agonizing over what to include. Well now you can just answer a few questions and the README will literally write itself. Was this README generated using this script? Yes! (mostly)

Table of Contents

• Installation
• Usage
• License
• Contributing
• Tests
• Questions

Installation

• Clone the repository
• Run npm install to install dependencies
• It's that easy

Usage

• Run node index.js
• Answer a few simple questions
• Your file will be generated for you

Features

• Automatic Table of Contents
• Repo link, Github user link, and email link included
• License badge created
• Description, Installation, Usage, License, Contributing, and Tests sections

Samples of Autogenerated Files

Link to Video With Sound

Same Video on Google Drive

Sample of autogenerated README file

Demo Gif

License

This project is provisioned under the MIT License

Contributing

Do you want to help make this project better? Visit the Github repo to check out existing issues or create a new branch to start working on a suggested feature

Tests

Testing still needs to be done! Please contribute if you'd like.

Questions

If you have any questions, please direct them to my Github or email