ezreadme

Easiest way to generate a simple README for your project

Prerequisites

npm

Installation

Run particular commands according to your package manager

// using npm
npm install ezreadme

// using yarn
yarn add ezreadme

Usage

generate-readme

How to

Checkout the generated READMEs here

Todo list

• [x] Publish the usable version
• [x] Add generated sample README
• [ ] Add png support
• [ ] Add gif support
• [ ] Add multiple README types selecions

Built with

• Nodejs

Author

• Thidasa Pankaja Paranavitharana
• Twitter
• Github

License

This project is under MIT license