diff --git a/README.md b/README.md index 3381256..530981b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,26 @@ # Disable-When-Hidden -AngularJS directive to remove the watchers related to elements outside of the viewport. +Very fast angular directive to remove the watchers related to elements outside of the viewport. No DOM manipulation. + +*Note: +This directive use the debug information provided by Angular by default, however we can disable it since 1.3 so if you did it (and you probably should have), it won't work.* + +## Usage +We have 2 directives. + +The first one to put on the parent element that contains the elements you want to disable, and the 2nd one to put on every element you wish to hide. + +I'll copy the basic example to explain better, here is a simple `ngRepeat`: + +```javascript +