From cc4a254fe6e2dc822167415e6b29438b8a2daf2c Mon Sep 17 00:00:00 2001 From: Lucas Serven Date: Mon, 11 Nov 2013 15:30:11 -0500 Subject: [PATCH] Document enhanced and --- Readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Readme.md b/Readme.md index 5be770f..346e613 100644 --- a/Readme.md +++ b/Readme.md @@ -66,10 +66,10 @@ postpone.setThreshold( "200px" ).postpone() // Change the threshold to 200px. ## API ### .stop() - Stop watching the document for changes. + Stop all of postpone's functionality. This means postpone will stop watching the document for changes and will unbind any scroll events associated with postponed elements. ### .start() - If you have paused postpone's watcher, you can start it back up with `.start()`. + If you have paused postpone's watcher and unbound its scroll evnts using `.stop()`, you can start it all back up with `.start()`. ### .isInViewport(element, [scrollElement]) Check if your `element` is somewhere in the browser's viewport, where `element` and `scrollElement` are DOM nodes. If `scrollElement` is not specified, postpone assumed `element` scrolls with respect to the document.