diff --git a/README.md b/README.md index a2f0d8e..d8bfa74 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ - # Antiscroll: cross-browser native OSX Lion scrollbars Antiscroll fixes a fundamental problem JavaScript UI developers commonly face: @@ -26,6 +25,30 @@ the scrollbars popularized by OS X Lion that retains native properties. Please click [here](http://learnboost.github.com/antiscroll/) to see it in action. +## Installation + +1. Wrap scrollable content with the class ```antiscroll-inner``` +1. Wrap the above with the class ```antiscroll-wrap``` +1. Include the following Javascript + +```javascript + $(function () { + $('.antiscroll-wrap').antiscroll(); + }); +``` + +### Configuration + +You may remove automatic scrollbar hiding by passing in a key-value to the ```antiscroll()``` function like so: + +```javascript + $(function () { + $('.antiscroll-wrap').antiscroll({ + autoHide: false + }); + }); +``` + ## What does it look like? **Firefox 8 `overflow: scroll` and antiscroll on OS X**