Skip to content

Commit

Permalink
edited Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
snake-345 committed Feb 18, 2016
1 parent a32adef commit 48a0137
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 5 deletions.
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,32 @@ $('.jcarousel')
.jcarousel() // init jcarousel
.jcarouselSwipe(); // init jcarouselSwipe
```

You may set options "perSwipe". It means how many slides will be scrolls at a go.

## Options
### perSwipe
It means how many slides will be scrolls at a go.
``` javascript
$('.jcarousel').jcarouselSwipe({
perSwipe: 3 // by default 1
});
```

### draggable
On/off dragging items on swipe.
``` javascript
$('.jcarousel').jcarouselSwipe({
draggable: false // by default true
});
```

### method
What method should used to switch slides.
``` javascript
$('.jcarousel').jcarouselSwipe({
method: 'scrollIntoView' // by default 'scroll'
});
```

## Examples
You can find examples in the corresponding directory. I'm included my plugin in all jcarousel examples and added vertical carousel example.

Expand Down
2 changes: 1 addition & 1 deletion bower.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "jcarouselSwipe",
"main": "./dist/jquery.jcarousel-swipe.js",
"version": "0.2.1",
"version": "0.3.0",
"authors": [
"Evgeniy Pelmenev <[email protected]>"
],
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "jcarouselSwipe",
"version": "0.2.1",
"version": "0.3.0",
"description": "Adds comfortable swipe gestures to jcarousel",
"author": "Evgeniy Pelmenev <[email protected]>",
"license": "MIT",
Expand Down
2 changes: 1 addition & 1 deletion src/jquery.jcarousel-swipe.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/*! jсarouselSwipe - v0.2.1 - 2015-12-10
/*! jсarouselSwipe - v0.3.0 - 2016-02-18
* Copyright (c) 2015 Evgeniy Pelmenev; Licensed MIT */
(function($) {
'use strict';
Expand Down

0 comments on commit 48a0137

Please sign in to comment.