rochal · iGureEV · Feb 5, 2018 · Feb 5, 2018 · Feb 5, 2018 · Feb 5, 2018
diff --git a/README.md b/README.md
@@ -2,7 +2,133 @@
 
 slimScroll is a small jQuery plugin that transforms any div into a scrollable area with a nice scrollbar - similar to the one Facebook and Google started using in their products recently. slimScroll doesn't occupy any visual space as it only appears on a user initiated mouse-over. User can drag the scrollbar or use mouse-wheel to change the scroll value.
 
-Demo and deocumentation available here: [jQuery slimScroll docs](http://rocha.la/jQuery-slimScroll)
+##Documentation
 
-Copyright (c) 2011 Piotr Rochala (http://rocha.la)
-Dual licensed under the MIT (http://www.opensource.org/licenses/mit-license.php) and GPL (http://www.opensource.org/licenses/gpl-license.php) licenses.
+Demo and documentation available here: [jQuery slimScroll docs](http://rocha.la/jQuery-slimScroll)
+
+###Example
+```
+<script type="text/javascript" src="libs/jquery.slimscroll.min.js"></script>
+
+// Hook document ready event
+$('document').ready(function(){
+    // Initialise slimScroll
+    $(selector).slimScroll({
+        height: '250px'
+    });
+});
+```
+
+###Default Options
+
+| Options           | Default               | Type              |   Description                                                         |
+| ----------------- | ----------------------| ----------------- | ----------------------------------------------------------------------
+| `allowPageScroll` | false                 | `boolean`         | check if mousewheel should scroll the window if we reach top/bottom   |
+| `alwaysVisible`   | false                 | `boolean`         | enables always-on mode for the scrollbar                              |
+| `animate`         | false                 | `boolean`         | sets animation status on a given scroll                               |
+| `barClass`        | 'slimScrollBar'       | `string`          | defautlt CSS class of the slimscroll bar                              |
+| `barClassH`       | 'slimScrollBarHor'    | `string`          | defautlt CSS class of the slimscroll bar (horizontal)                 |
+| `barFixSize`      | 0                     | `number`          | fixed bar height/width (set size in pixels                            |
+| `borderRadius`    | '7px'                 | `string[pixel]`   | sets border radius                                                    |
+| `color`           | '#000'                | `string[hex code]`| scrollbar color, accepts any hex/color value                          |
+| `cursor`          | 'normal'              | `string`          | cursor for for the scroll bar                                         |
+| `disableFadeOut`  | false                 | `boolean`         | check if we should hide the scrollbar when user is hovering over      |
+| `distance`        | '1px'                 | `string[pixel]`   | distance in pixels between the side edge and the scrollbar            |
+| `height`          | '250px'               | `string[pixel]`   | height in pixels of the visible scroll area                           |
+| `horizontal`      | false                 | `boolean`         | enable scroll horizontal                                              |
+| `opacity`         | 0.4                   | `number`          | sets scrollbar opacity                                                |
+| `position`        | 'right'               | `string`          | scrollbar position - left/right                                       |
+| `railBorderRadius`| '7px'                 | `string[pixel]`   | sets border radius of the rail                                        |
+| `railClass`       | 'slimScrollRail'      | `string`          | defautlt CSS class of the slimscroll rail                             |
+| `railClassH`      | 'slimScrollRailHor'   | `string`          | defautlt CSS class of the slimscroll rail (horizontal)                |
+| `railColor`       | '#333'                | `string[pixel]`   | sets rail color                                                       |
+| `railDraggable`   | true                  | `boolean`         | whether we should use jQuery UI Draggable to enable bar dragging      |
+| `railOpacity`     | 0.2                   | `number`          | sets rail opacity                                                     |
+| `railVisible`     | false                 | `boolean`         | sets visibility of the rail                                           |
+| `size`            | '7px'                 | `string[pixel]`   | width in pixels of the scrollbar and rail                             |
+| `start`           | 'top'                 | `string`          | default scroll position on load - top / bottom / $('selector')        |
+| `touchScrollStep` | 200                   | `number`          | scroll amount applied when user is using gestures                     |
+| `wheelStep`       | 20                    | `number`          | scroll amount applied to each mouse wheel step                        |
+| `width`           | 'auto'                | `number|string`   | width in pixels of the visible scroll area                            |
+| `wrapperClass`    | 'slimScrollDiv'       | `string`          | defautlt CSS class of the slimscroll wrapper                          |
+| `zIndex`          | 90                    | `number`          | z-index for the scroll bar                                            |
+
+
+
+####Example
+
+```
+$(selector).slimScroll({
+    width          : '300px',
+    height         : '500px',
+    size           : '10px',
+    position       : 'left',
+    color          : '#ffcc00',
+    alwaysVisible  : true,
+    distance       : '20px',
+    start          : $('#child_image_element'),
+    railVisible    : true,
+    railColor      : '#222',
+    railOpacity    : 0.3,
+    wheelStep      : 10,
+    allowPageScroll: false,
+    disableFadeOut : false
+});
+```
+
+
+
+###Events
+
+* `slimscroll`
+
+When the scrollbar reaches top or bottom of the parent container, slimscroll will trigger the slimscroll event. Use jQuery bind to capture this event:
+
+```
+$(selector).slimScroll().bind('slimscroll', function(e, pos){
+    console.log("Reached " + pos);
+});
+```
+
+* `slimscrolling`
+
+When scrolling within slimscroll, the slimscrolling event is triggered. Use jQuery bind to capture this event:
+
+```
+$(selector).slimScroll().bind('slimscrolling', function(e, msg){
+    console.log(msg);
+});
+```
+
+Note: The slimscrolling event will be triggered no matter if the div has actually been able to move.
+
+
+
+###Public Calls
+
+* `scrollTo`
+
+Jumps to the specified scroll value. Can be called on any element with slimScroll already enabled. 
+
+```
+$(selector).slimScroll({ 
+    scrollTo: '50px' 
+});
+```
+
+* `scrollBy`
+
+Increases/decreases current scroll value by specified amount (positive or negative). Can be called on any element with slimScroll already enabled.
+
+```
+$(selector).slimScroll({ 
+    scrollBy: '60px' 
+});
+```
+
+
+
+
+Copyright (c) 2011 Piotr Rochala (http://rocha.la)    
+Dual licensed under the MIT (http://www.opensource.org/licenses/mit-license.php)    
+and GPL (http://www.opensource.org/licenses/gpl-license.php) licenses.
diff --git a/examples/animate-scroll.html b/examples/animate-scroll.html
@@ -0,0 +1,54 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<title>jquery.slimscroll - mouse wheel</title>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
+
+<link href="libs/prettify/prettify.css" type="text/css" rel="stylesheet" />
+<script type="text/javascript" src="libs/prettify/prettify.js"></script>
+<script type="text/javascript" src="../jquery.slimscroll.js"></script>
+<link href="style.css" type="text/css" rel="stylesheet" />
+</head>
+<body>
+<a id="git-fork" href="https://github.com/rochal/jQuery-slimScroll"><img src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png" alt="Fork me on GitHub"></a>
+
+<div class="examples">
+  <div id="testDiv">
+    <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam rhoncus, felis interdum condimentum consectetur, nisl libero elementum eros, vehicula congue lacus eros non diam. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Vivamus mauris lorem, lacinia id tempus non, imperdiet et leo. Cras sit amet erat sit amet lacus egestas placerat. Aenean ultricies ultrices mauris ac congue. In vel tortor vel velit tristique tempus ac id nisi. Proin quis lorem velit. Nunc dui dui, blandit a ullamcorper vitae, congue fringilla lectus. Aliquam ultricies malesuada feugiat. Vestibulum placerat turpis et eros lobortis vel semper sapien pulvinar.</p>
+    <p>Pellentesque rhoncus aliquet porta. Sed vel magna eu turpis pharetra consequat ut vitae lectus. In molestie sollicitudin mi sit amet convallis. Aliquam erat volutpat. Nullam feugiat placerat ipsum eget malesuada. Nulla facilisis nunc non dolor vehicula pretium. Sed dui magna, sodales id pharetra non, ullamcorper eu sapien. Mauris ac consectetur leo. Mauris consequat, lectus ut bibendum pulvinar, leo magna feugiat enim, eu commodo lacus sem vel ante. Sed tempus metus eget leo mollis vulputate. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos.</p>
+    <p>Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed pulvinar rhoncus quam, vel semper tellus viverra id. Nulla rutrum porttitor odio, a rutrum purus gravida non. Etiam ac purus augue, eget vestibulum purus. Aenean venenatis ullamcorper augue, non consequat elit tempor sed. Donec velit sapien, volutpat sed ultricies egestas, semper a ante. Fusce dapibus, quam eget auctor suscipit, nibh leo posuere ante, at auctor nisi lacus in sem. Morbi interdum consectetur euismod. Cras accumsan est lacus. Nulla eleifend, eros vel consequat commodo, arcu nunc malesuada nunc, quis sagittis felis sem ac turpis.</p>
+    <p>Nulla rhoncus elementum convallis. Mauris condimentum aliquet egestas. Ut iaculis nisi eget tellus accumsan venenatis. Maecenas imperdiet aliquam porta. Aenean ultrices dolor sed quam laoreet varius. Curabitur condimentum blandit erat, quis accumsan eros interdum vitae. Curabitur ligula arcu, sollicitudin vitae iaculis sed, blandit sit amet enim. Morbi ullamcorper, metus vel mollis tristique, arcu turpis malesuada nisi, at dignissim lorem odio a orci. Proin ultrices, ipsum ut vestibulum interdum, libero felis auctor mi, vitae convallis nisl justo ac tellus. Integer nec lacinia turpis. Etiam massa nisl, rhoncus quis rutrum in, pretium eu leo. Proin a velit ut nulla laoreet vestibulum. Curabitur eu elit vitae felis auctor tincidunt. Curabitur tincidunt, metus sed sollicitudin cursus, quam elit commodo erat, ut tempor erat sapien vitae velit. Morbi nec viverra erat.</p>
+    <p>Nullam scelerisque facilisis pretium. Vivamus lectus leo, commodo ac sagittis ac, dictum a mi. Donec quis massa ut libero malesuada commodo in et risus. Fusce nunc dolor, aliquet vel rutrum in, molestie sit amet massa. Aliquam suscipit, justo a commodo condimentum, enim sapien fringilla ante, sed lobortis orci lectus in ante. Donec vel interdum est. Donec placerat cursus lacus, eu ultricies nisl tincidunt a. Fusce libero risus, sagittis eleifend iaculis aliquet, condimentum vitae diam. Suspendisse potenti. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Proin leo purus, sodales a venenatis luctus, faucibus ac enim. Sed id metus ac sem lobortis pretium. Mauris faucibus tempor scelerisque. Nunc vulputate interdum tortor, non tincidunt dui condimentum eget. Aenean in porttitor velit. Nam accumsan rhoncus risus id consectetur.</p>
+    <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam rhoncus, felis interdum condimentum consectetur, nisl libero elementum eros, vehicula congue lacus eros non diam. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Vivamus mauris lorem, lacinia id tempus non, imperdiet et leo. Cras sit amet erat sit amet lacus egestas placerat. Aenean ultricies ultrices mauris ac congue. In vel tortor vel velit tristique tempus ac id nisi. Proin quis lorem velit. Nunc dui dui, blandit a ullamcorper vitae, congue fringilla lectus. Aliquam ultricies malesuada feugiat. Vestibulum placerat turpis et eros lobortis vel semper sapien pulvinar.</p>
+    <p>Pellentesque rhoncus aliquet porta. Sed vel magna eu turpis pharetra consequat ut vitae lectus. In molestie sollicitudin mi sit amet convallis. Aliquam erat volutpat. Nullam feugiat placerat ipsum eget malesuada. Nulla facilisis nunc non dolor vehicula pretium. Sed dui magna, sodales id pharetra non, ullamcorper eu sapien. Mauris ac consectetur leo. Mauris consequat, lectus ut bibendum pulvinar, leo magna feugiat enim, eu commodo lacus sem vel ante. Sed tempus metus eget leo mollis vulputate. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos.</p>
+    <p>Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed pulvinar rhoncus quam, vel semper tellus viverra id. Nulla rutrum porttitor odio, a rutrum purus gravida non. Etiam ac purus augue, eget vestibulum purus. Aenean venenatis ullamcorper augue, non consequat elit tempor sed. Donec velit sapien, volutpat sed ultricies egestas, semper a ante. Fusce dapibus, quam eget auctor suscipit, nibh leo posuere ante, at auctor nisi lacus in sem. Morbi interdum consectetur euismod. Cras accumsan est lacus. Nulla eleifend, eros vel consequat commodo, arcu nunc malesuada nunc, quis sagittis felis sem ac turpis.</p>
+    <p>Nulla rhoncus elementum convallis. Mauris condimentum aliquet egestas. Ut iaculis nisi eget tellus accumsan venenatis. Maecenas imperdiet aliquam porta. Aenean ultrices dolor sed quam laoreet varius. Curabitur condimentum blandit erat, quis accumsan eros interdum vitae. Curabitur ligula arcu, sollicitudin vitae iaculis sed, blandit sit amet enim. Morbi ullamcorper, metus vel mollis tristique, arcu turpis malesuada nisi, at dignissim lorem odio a orci. Proin ultrices, ipsum ut vestibulum interdum, libero felis auctor mi, vitae convallis nisl justo ac tellus. Integer nec lacinia turpis. Etiam massa nisl, rhoncus quis rutrum in, pretium eu leo. Proin a velit ut nulla laoreet vestibulum. Curabitur eu elit vitae felis auctor tincidunt. Curabitur tincidunt, metus sed sollicitudin cursus, quam elit commodo erat, ut tempor erat sapien vitae velit. Morbi nec viverra erat.</p>
+    <p>Nullam scelerisque facilisis pretium. Vivamus lectus leo, commodo ac sagittis ac, dictum a mi. Donec quis massa ut libero malesuada commodo in et risus. Fusce nunc dolor, aliquet vel rutrum in, molestie sit amet massa. Aliquam suscipit, justo a commodo condimentum, enim sapien fringilla ante, sed lobortis orci lectus in ante. Donec vel interdum est. Donec placerat cursus lacus, eu ultricies nisl tincidunt a. Fusce libero risus, sagittis eleifend iaculis aliquet, condimentum vitae diam. Suspendisse potenti. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Proin leo purus, sodales a venenatis luctus, faucibus ac enim. Sed id metus ac sem lobortis pretium. Mauris faucibus tempor scelerisque. Nunc vulputate interdum tortor, non tincidunt dui condimentum eget. Aenean in porttitor velit. Nam accumsan rhoncus risus id consectetur.</p>
+    <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam rhoncus, felis interdum condimentum consectetur, nisl libero elementum eros, vehicula congue lacus eros non diam. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Vivamus mauris lorem, lacinia id tempus non, imperdiet et leo. Cras sit amet erat sit amet lacus egestas placerat. Aenean ultricies ultrices mauris ac congue. In vel tortor vel velit tristique tempus ac id nisi. Proin quis lorem velit. Nunc dui dui, blandit a ullamcorper vitae, congue fringilla lectus. Aliquam ultricies malesuada feugiat. Vestibulum placerat turpis et eros lobortis vel semper sapien pulvinar.</p>
+    <p>Pellentesque rhoncus aliquet porta. Sed vel magna eu turpis pharetra consequat ut vitae lectus. In molestie sollicitudin mi sit amet convallis. Aliquam erat volutpat. Nullam feugiat placerat ipsum eget malesuada. Nulla facilisis nunc non dolor vehicula pretium. Sed dui magna, sodales id pharetra non, ullamcorper eu sapien. Mauris ac consectetur leo. Mauris consequat, lectus ut bibendum pulvinar, leo magna feugiat enim, eu commodo lacus sem vel ante. Sed tempus metus eget leo mollis vulputate. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos.</p>
+    <p>Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed pulvinar rhoncus quam, vel semper tellus viverra id. Nulla rutrum porttitor odio, a rutrum purus gravida non. Etiam ac purus augue, eget vestibulum purus. Aenean venenatis ullamcorper augue, non consequat elit tempor sed. Donec velit sapien, volutpat sed ultricies egestas, semper a ante. Fusce dapibus, quam eget auctor suscipit, nibh leo posuere ante, at auctor nisi lacus in sem. Morbi interdum consectetur euismod. Cras accumsan est lacus. Nulla eleifend, eros vel consequat commodo, arcu nunc malesuada nunc, quis sagittis felis sem ac turpis.</p>
+    <p>Nulla rhoncus elementum convallis. Mauris condimentum aliquet egestas. Ut iaculis nisi eget tellus accumsan venenatis. Maecenas imperdiet aliquam porta. Aenean ultrices dolor sed quam laoreet varius. Curabitur condimentum blandit erat, quis accumsan eros interdum vitae. Curabitur ligula arcu, sollicitudin vitae iaculis sed, blandit sit amet enim. Morbi ullamcorper, metus vel mollis tristique, arcu turpis malesuada nisi, at dignissim lorem odio a orci. Proin ultrices, ipsum ut vestibulum interdum, libero felis auctor mi, vitae convallis nisl justo ac tellus. Integer nec lacinia turpis. Etiam massa nisl, rhoncus quis rutrum in, pretium eu leo. Proin a velit ut nulla laoreet vestibulum. Curabitur eu elit vitae felis auctor tincidunt. Curabitur tincidunt, metus sed sollicitudin cursus, quam elit commodo erat, ut tempor erat sapien vitae velit. Morbi nec viverra erat.</p>
+    <p>Nullam scelerisque facilisis pretium. Vivamus lectus leo, commodo ac sagittis ac, dictum a mi. Donec quis massa ut libero malesuada commodo in et risus. Fusce nunc dolor, aliquet vel rutrum in, molestie sit amet massa. Aliquam suscipit, justo a commodo condimentum, enim sapien fringilla ante, sed lobortis orci lectus in ante. Donec vel interdum est. Donec placerat cursus lacus, eu ultricies nisl tincidunt a. Fusce libero risus, sagittis eleifend iaculis aliquet, condimentum vitae diam. Suspendisse potenti. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Proin leo purus, sodales a venenatis luctus, faucibus ac enim. Sed id metus ac sem lobortis pretium. Mauris faucibus tempor scelerisque. Nunc vulputate interdum tortor, non tincidunt dui condimentum eget. Aenean in porttitor velit. Nam accumsan rhoncus risus id consectetur.</p>
+  </div>
+
+<pre class="prettyprint">
+  $('#testDiv').slimscroll({
+      animate: true
+  });
+</pre>
+
+</div>
+
+<script type="text/javascript">
+    $(function(){
+
+      $('#testDiv').slimscroll({
+          animate: true
+      });
+
+    });
+</script>
+
+</body>
+</html>
diff --git a/examples/navigation.html b/examples/navigation.html
@@ -24,6 +24,7 @@ <h2>Facebook-style jQuery Scrollbar</h1>
     <li><a target="main" href="mouse-wheel.html">wheelStep option</a></li>
     <li><a target="main" href="nested.html">nested elements</a></li>
     <li><a target="main" href="dynamic-content.html">dynamic content</a></li>
+    <li><a target="main" href="animate-scroll.html">smooth scrolling</a></li>
   </ul>
 </div>
 </body>