diff --git a/changes.txt b/CHANGELOG similarity index 95% rename from changes.txt rename to CHANGELOG index 0316ef4..4e724d3 100644 --- a/changes.txt +++ b/CHANGELOG @@ -1,3 +1,7 @@ +1.3.0 +[Compat] +- Updated to work with jQuery.scrollTo 2.0 + 1.2.4.1 [Misc] - Using $.isNumeric instead of isNaN diff --git a/README.md b/README.md index 3b75e02..fa4ef1c 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,25 @@ -# jQuery.SerialScroll - ### Installation and usage -Using [bower](https://github.com/twitter/bower): +Via [bower](https://github.com/twitter/bower): ```bash bower install jquery.serialScroll ``` +Via [npm](https://www.npmjs.com/package/jquery.serialscroll): +```bash +npm install jquery.serialscroll +``` ### Downloading Manually If you want the latest stable version, get the latest release from the [releases page](https://github.com/flesler/jquery.serialScroll/releases). -### Notes +### jQuery.scrollTo + +This plugin requires [jQuery.scrollTo](http://github.com/flesler/jquery.scrollTo). +In order to use jQuery.scrollTo 2.0 you need to update jQuery.localScroll to 1.3.0 and above. -* The plugin requires jQuery.ScrollTo. http://github.com/flesler/jquery.scrollTo +### Notes -* The hash of settings is passed in to jQuery.ScrollTo, so, in addition to jQuery.LocalScroll's settings, you can use any of jQuery.ScrollTo's. Check that plugin's documentation for further information. +* The hash of settings is passed in to jQuery.scrollTo, so, in addition to jQuery.localScroll's settings, you can use any of jQuery.scrollTo's. Check that plugin's documentation for further information. -* Most of this plugin's defaults, belong to jQuery.ScrollTo, check it's demo for an example of each option. \ No newline at end of file +* Most of this plugin's defaults, belong to jQuery.scrollTo, check it's demo for an example of each option. \ No newline at end of file diff --git a/component.json b/bower.json similarity index 78% rename from component.json rename to bower.json index 1704a52..10a0ed6 100644 --- a/component.json +++ b/bower.json @@ -1,7 +1,7 @@ { "name": "jquery.serialScroll", - "version": "1.2.4", - "description": "Animated scrolling of series.", + "version": "1.3.0", + "description": "Animated scrolling of series with jQuery", "homepage": "https://github.com/flesler/jquery.serialScroll", "main": [ "./jquery.serialScroll.js", @@ -9,7 +9,7 @@ ], "dependencies": { "jquery" : ">=1.8", - "jquery.scrollTo" : ">=1.4.3" + "jquery.scrollTo" : ">=2.1.0" }, "keywords": [ "slideshow", "sequence", "animated", "animation", "scrolling", "scroll", "prev", "next" ], "author": { diff --git a/demo/index.html b/demo/index.html index 6f26064..b178232 100644 --- a/demo/index.html +++ b/demo/index.html @@ -8,7 +8,7 @@ - +