From 1b6a4b2d9d5c2d07ae5a38429da0c8d3a323a725 Mon Sep 17 00:00:00 2001 From: Gil Barbara Date: Fri, 11 Sep 2015 21:32:34 -0300 Subject: [PATCH] version 0.2.5 - bower --- README.md | 26 ++++++++++++++++++++++---- package.json | 2 +- 2 files changed, 23 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d97310a..95b85bf 100644 --- a/README.md +++ b/README.md @@ -8,19 +8,37 @@ Supports `scrollbar, mousewheel, touchmove, keydown` events. ## Install +### npm ```javascript npm install --save disable-scroll ``` -## Usage +and require it + ```javascript var disableScroll = require('disable-scroll'); +``` + +### bower +```javascript +bower install --save disable-scroll +``` + +Reference the script in your html file -disableScroll.on(); +```html + +``` + +## Usage + +```javascript +disableScroll.on(); // prevent scrolling ... -disableScroll.off(); +disableScroll.off(); // re-enable scroll ``` + ## API ### .on([element], [options]) @@ -39,7 +57,7 @@ Disable page scrolling by adding event listeners and locking the scroll position ``` ### .off() -Re-enable page scrolling and remove the listeners. +Re-enable page scrolling and destroy the listeners. --- diff --git a/package.json b/package.json index 6dec46c..02d17da 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "disable-scroll", - "version": "0.2.0", + "version": "0.2.5", "description": "Prevent page scroll", "author": "Gil Barbara ", "repository": {