jquery-drawer/README.md

Flexible drawer menu using jQuery, iScroll and CSS.

# [Drawer](http://blivesta.github.io/drawer)

![Bower version](https://img.shields.io/bower/v/drawer.svg?style=flat)
[![npm version](https://img.shields.io/npm/v/jquery-drawer.svg?style=flat)](https://www.npmjs.com/package/jquery-drawer)
[![Build Status](https://img.shields.io/travis/blivesta/drawer/master.svg?style=flat)](https://travis-ci.org/blivesta/drawer)

> Flexible drawer menu using jQuery, iScroll and CSS.

## [Demo & Installation](http://git.blivesta.com/drawer/)

### CDN

cdnjs

- [jQuery](https://cdnjs.com/libraries/jquery)
- [iScroll](https://cdnjs.com/libraries/iScroll)
- [Drawer](https://cdnjs.com/libraries/drawer)

### Package Managers

npm

```
$ npm install jquery-drawer jquery@2.2.4 iscroll
```

bower

```
$ bower install drawer jquery#2.2.4 iscroll
```
## Dependencies
- [jQuery 1.9.1+](https://github.com/jquery/jquery)
- [iScroll 5](https://github.com/cubiq/iscroll)

## Development

```bash
$ git clone https://github.com/blivesta/drawer.git
$ cd drawer
$ git checkout -b patch-1
$ npm install && gulp build
```

Build
```bash
$ gulp build
```

Watch & Connect
```bash
$ gulp
```

## Contributors
- [@blivesta](https://github.com/blivesta)
- [@ungki](https://github.com/ungki)(Maintainer)
- [@tylerball](https://github.com/tylerball)
- [@PeterDaveHello](https://github.com/PeterDaveHello)
- [@jasonniebauer](https://github.com/jasonniebauer)
- [@mrDinckleman](https://github.com/mrDinckleman)
- [@magicmarkker](https://github.com/magicmarkker)
- [@mrodrigues](https://github.com/mrodrigues)
- [@leorochael](https://github.com/leorochael)

## Contributing

To contribute to Drawer, clone this repo locally and commit your code.
Please check that everything works before opening a pull-request.

## License
Copyright 2014-2016 Released under the [MIT license](https://github.com/blivesta/drawer/blob/master/LICENSE.md).