Update readme for release 1.0.1

Author: Lawrence Goldstien

README.md

@@ -8,6 +8,14 @@ Download the [production version][min] or the [development version][max].
 [min]: https://raw.github.com/lgoldstien/jquery-dragpan/master/dist/dragpan.min.js
 [max]: https://raw.github.com/lgoldstien/jquery-dragpan/master/dist/dragpan.js
 
+###Requirements
+
+jQuery Dragpan has the following requirements:
+
+* [jQuery](http://jquery.com/download/)
+* [jQuery UI](http://jqueryui.com/download/)
+  * Requires UI Core - Core and Widget
+
 ###Usage
 
     <div id="document">
@@ -24,6 +32,8 @@ Download the [production version][min] or the [development version][max].
 
 ###Options
 
+Options can be parsed when Dragpan is instatiated on an element or after.
+
 ####Speed
 
 You can adjust the speed of the drag using the speedX and speedY options.
@@ -40,11 +50,26 @@ You can set the parent element, this is useful if the viewport sized element is
 
 By default this will be the element you are using the dragpan method on.
 
-## Documentation
-_(Coming soon)_
+####On
+
+You can tell dragpan to instantiate without enabling functionality using the following:
+
+    $("element").dragpan({ on: false });
+
+This will default to true meaning if you do not specify this then the dragpan functionality will be enabled.
+
+###Methods
+
+You can use methods the following non-private methods:
+
+####On
+
+You can turn on dragpan functionality using the following on an already instantiated dragpan instance.
+
+    $("element").dragpan('on');
+
+####Off
 
-## Examples
-_(Coming soon)_
+You can turn off the dragpan functionality using the following on an already instantiated dragpan instance.
 
-## Release History
-_(Nothing yet)_
+    $("element").dragpan('off');

src/dragpan.js

@@ -10,40 +10,6 @@ $.widget( "oml.dragpan", {
     },
     vars: {},
 
-    // The public functions
-    on: function () {
-        // Set the cursor
-        _this.options.$parent.css( "cursor", _this.options.cursor );
-        
-        // Disable selection dragging
-        _this.vars.$parent.css( "-webkit-touch-callout", "none" );
-        _this.vars.$parent.css( "-webkit-user-select", "none" );
-        _this.vars.$parent.css( "-khtml-user-select", "none" );
-        _this.vars.$parent.css( "-moz-user-select", "-moz-none" );
-        _this.vars.$parent.css( "-ms-user-select", "none" );
-        _this.vars.$parent.css( "user-select", "none" );
-
-        // Add the mouse binding
-        this._addMouseBinding();
-    },
-    off: function () {
-        // Enable selection dragging if it was enabled to begin with
-        if (_this.vars.selection === true) {
-            _this.vars.$parent.css( "-webkit-touch-callout", "all" );
-            _this.vars.$parent.css( "-webkit-user-select", "all" );
-            _this.vars.$parent.css( "-khtml-user-select", "all" );
-            _this.vars.$parent.css( "-moz-user-select", "all" );
-            _this.vars.$parent.css( "-ms-user-select", "all" );
-            _this.vars.$parent.css( "user-select", "all" );
-        }
-
-        // Set back to default cursor
-        _this.options.$parent.css( "cursor", "default" );
-
-        // Remove the mouse binding
-        this._removeMouseBinding();
-    },
-
     // The class construct
     _create: function() {
         // This fix
@@ -161,6 +127,40 @@ $.widget( "oml.dragpan", {
     _removeMouseBinding: function () {
         _this.vars.$parent.off();
         _this._dragging( 'off' );
+    },
+
+    // The public functions
+    on: function () {
+        // Set the cursor
+        _this.options.$parent.css( "cursor", _this.options.cursor );
+        
+        // Disable selection dragging
+        _this.vars.$parent.css( "-webkit-touch-callout", "none" );
+        _this.vars.$parent.css( "-webkit-user-select", "none" );
+        _this.vars.$parent.css( "-khtml-user-select", "none" );
+        _this.vars.$parent.css( "-moz-user-select", "-moz-none" );
+        _this.vars.$parent.css( "-ms-user-select", "none" );
+        _this.vars.$parent.css( "user-select", "none" );
+
+        // Add the mouse binding
+        this._addMouseBinding();
+    },
+    off: function () {
+        // Enable selection dragging if it was enabled to begin with
+        if (_this.vars.selection === true) {
+            _this.vars.$parent.css( "-webkit-touch-callout", "all" );
+            _this.vars.$parent.css( "-webkit-user-select", "all" );
+            _this.vars.$parent.css( "-khtml-user-select", "all" );
+            _this.vars.$parent.css( "-moz-user-select", "all" );
+            _this.vars.$parent.css( "-ms-user-select", "all" );
+            _this.vars.$parent.css( "user-select", "all" );
+        }
+
+        // Set back to default cursor
+        _this.options.$parent.css( "cursor", "default" );
+
+        // Remove the mouse binding
+        this._removeMouseBinding();
     }
 
 });