diff --git a/README.md b/README.md index d3f2bc7..c67b474 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,29 @@ # vue-burger-menu [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) -An off-canvas sidebar Vue component with a collection of effects and styles using CSS transitions and SVG path animations. \ No newline at end of file +An off-canvas sidebar Vue component with a collection of effects and styles using CSS transitions and SVG path animations. + +## Demo & examples + +Live demo - [WIP] + +To build the examples locally, run: + +``` +yarn +yarn serve +``` + +Then open [`localhost:8000`](httpL//localhost:8000) in a browser + +## Installation + +``` +npm install vue-burger-menu --save +``` + +``` +yarn add vue-burger-menu +``` + +## Usage \ No newline at end of file