# jquery-waves
A simple & lightweight waves effect plugin

---

<center>

![Requires.io](https://img.shields.io/requires/github/isaeken/jquery-waves) ![npm](https://img.shields.io/npm/dt/jquery-waves) ![GitHub](https://img.shields.io/github/license/isaeken/jquery-waves) ![npm](https://img.shields.io/npm/v/jquery-waves)
![GitHub followers](https://img.shields.io/github/followers/isaeken?style=social) ![GitHub Repo stars](https://img.shields.io/github/stars/isaeken/jquery-waves?style=social)

</center>

---

![isaeken/jquery-waves](https://raw.githubusercontent.com/isaeken/jquery-waves/master/docs/img/ss.png)

## Installation
You can install jquery-waves plugin using npm or include directly files

#### install using npm
```bash
npm install animejs
npm install jquery-waves
```
#### or include files
````html
<head>
...
<link rel="stylesheet" href="/your/servers/assets/path/css/jquery-waves.min.css">
<script src="/your/servers/assets/path/js/jquery.min.js"></script>
<script src="/your/servers/assets/path/js/anime.min.js"></script>
<script src="/your/servers/assets/path/js/jquery-waves.min.js"></script>
...
</head>
````

## Simple Usage
Creating wave effect with classes
````html
<button class="waves-effect">Click me</button>
````
or programmatically
````javascript
$('#element').rippleAnimation();
````

## Help and docs
Please report bugs from issues tab
- [Documentation](https://isaeken.github.io/jquery-waves/)
