Skip to content

Commit

Permalink
docs:readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
mbj36 committed Aug 25, 2018
1 parent ab66386 commit b137c34
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.
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

0 comments on commit b137c34

Please sign in to comment.