# vue-rippler 🎉
> Simple Vue.js plugin for custom ripple effect
[![vue2](https://img.shields.io/badge/vue-2.x-brightgreen.svg)](https://vuejs.org/)
[![Version](https://img.shields.io/npm/v/vue-rippler.svg)](https://www.npmjs.com/package/vue-rippler)
[![Gzipsize](https://img.badgesize.io/spemer/vue-rippler/master/src/vue-rippler.js?compression=gzip)](https://www.npmjs.com/package/vue-rippler)
[![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/vuejs/awesome-vue#miscellaneous)
[![License](https://img.shields.io/npm/l/vue-rippler.svg)](https://github.com/spemer/vue-rippler)
[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fspemer%2Fvue-rippler&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)](https://github.com/spemer/vue-rippler)
[![stargazers](https://img.shields.io/github/stars/spemer/vue-rippler?style=social)](https://github.com/spemer/vue-rippler)
[Live Demo](https://spemer.github.io/vue-rippler/)
## Installation
```bash
npm i vue-rippler --save
```
```bash
yarn add vue-rippler
```
### CDNs
[jsDelivr](https://cdn.jsdelivr.net/npm/vue-rippler/),
[UNPKG](https://unpkg.com/vue-rippler/),
[bundle.run](https://bundle.run/vue-rippler)
## Usage
### main.js
```javascript
// main.js
import Vue from "vue";
import VueRippler from "vue-rippler";
Vue.use(VueRippler);
```
### Use in component
```javascript
// .vue template
```
### Set ripple style, and customize as you want(Optional)
```css
```
## Author
[Hyouk Seo(Spemer)](https://github.com/spemer)