Update README.md

Add documentation for new events
garand · Jul 22, 2014 · 43516ec · 43516ec
1 parent 7661194
commit 43516ec
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -47,3 +47,16 @@ This is how it works:
 - `sticky(options)`: Initializer. `options` is optional.
 - `sticky('update')`: Recalculates the element's position.
 
+## Events
+
+- `sticky-start`: When the element becomes sticky.
+- `sticky-end`: When the element returns to its original location
+
+To subscribe to events use jquery:
+
+```html
+<script>
+  $('#sticker').on('sticky-start', function() { console.log("Started"); });
+  $('#sticker').on('sticky-end', function() { console.log("Ended"); });
+</script>
+```