## Introduction
Vuescroll is a scrollbar plugin based on Vue.js 2.X, it is very easy to use, no complex options and each option has its default value(It means you don't even have to write any configuration). Just wrap the content by `` and a custom scrollbar will show. It supports:
- Customizable scrollbar
- Pull-to-refresh, push-to-load
- Carousel
_Vuescroll's compatibility is the same as `Vue.js 2.X`._
## Demo
- You can find demo under examples folder of repo.
- You can see the full features of vuescroll at [Live Demo](https://vuescrolljs.yvescoding.me/demo) section of the website.
## Install
```bash
npm i vuescroll -S
# OR
yarn add vuescroll
```
## Usage
### Import and registry
```js
import vuescroll from 'vuescroll';
import Vue from 'vue';
Vue.use(vuescroll);
// OR
Vue.component('vue-scroll', vuescroll);
```
### Wrap the content by vue-scroll
```html
```
## Documentation
For detailed docs, please see [Guide](https://vuescrolljs.yvescoding.me/guide) section on the website.
## Communication
- Wechat
- Twitter
[@wangyi70991](https://twitter.com/wangyi70991)
## License
**MIT** By Yves Wang(Wangyi Yi)