Automated Readme Generator.

Description 🤓

Super awesome application which dynamically generates and opens a README.md file based on user inputs

Important Considerations ❗

1. Our goal is to make your README.md looks concise, informative and resourceful, hence all prompts are mandatory
2. To make your user experience even better, we designed our code to automatically open the generated README.md in .md viewer.

Table of Contents

• 🔧 Installation
• 🗒️ Usage
• ⚖️ License
• 📺 Demo

Installation

$ git clone git@github.com:yulduzetta/readme-generator.git
$ cd readme-generator.git
$ npm install --save-dev

Usage

$ node index.js

License

MIT License

Demo

1. Demo video will walk you through the application and its usage
2. Sample README.md can be found here

Click on the giphy to watch full demo