# SliderPlex
A simple and responsive jQuery content slider plugin. See a [demo](https://e200.github.io/SliderPlex/demo/).
## Table of contents
- [Installation](#installation)
- [Usage](#usage)
- [Options](#options)
- [Contribute](#contribute)
- [Credits](#credits)
- [License](#license)
## Installation
Install it using one of the follow options:
1. Using [Git](https://pt.wikipedia.org/wiki/Git):
git clone git://github.com/e200/SliderPlex.git
2. Using [Bower](https://bower.io/docs):
bower install sliderplex
3. Using [npm](https://www.npmjs.com/):
npm install sliderplex
in a **terminal/prompt** in your project folder, then add *jQuery* and **SliderPlex** files (CSS & JavaScript) to your page:
```html
```
## Usage
First, setup your slider structure:
```html
```
Sets how many slides you want. Then, initialize the SliderPlex before the body close tag:
```html
```
Full usage code:
```html
SliderPlex example
!-- jQuery must be before SliderPlex -->
```
And... That's it!!! :)
## Options
You can pass an object containing options to the SliderPlex initialization method:
```js
$('.slider').SliderPlex({
autoPlay: false,
animation: 'fade'
});
```
##### Available options:
```
autoPlay | default: true
slideInterval | default: 8 (sec)
animation | default: 'fade' [fade, zoom, slide]
animationTime | default: .5 (sec)
direction | default: 'right'
arrows | default: true
nonFocusArrows | default: false
pauseOnMouseOver | default: false
pauseOnMouseDown | default: true
fillSpace | default: true
```
## Contributing
To contribute, please, read [contributing](https://github.com/e200/SliderPlex/contributing.md).
## Bugs
Please, open an [issue](https://github.com/e200/SliderPlex/issues/new), or report to: [eleandro@inbox.ru](mailto://eleandro@inbox.ru).
## Credits
- [Eleandro Duzentos](https://github.com/e200) and contributors.
## License
The SliderPlex is licensed under the MIT license. See [License](https://github.com/e200/SliderPlex/license) file for more information.
