From 412b4a47a1ad7643b0aded7b492b288a5463b8f1 Mon Sep 17 00:00:00 2001 From: Jordan Burke Date: Sun, 6 Jul 2014 22:14:46 -0400 Subject: [PATCH] Updated the readme. --- README.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b3a2119..8af448b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,30 @@ angular-help-overlay ==================== -Angular Wrapper for chardin.js instruction overlay +Angular Wrapper for [chardin.js](https://github.com/heelhook/chardin.js "Chardin.js") instruction overlay which was inspired by the "new" Gmail composer tour. + +Usage is straightforward: + +Find the dom element where you want to the overlay to appear (e.g., body, div, etc.) and add this tag to the element: + +``` +... +``` + +With showHelp being a scoped boolean property. Setting that property to true will enable the overlay. Since this is just +an AngularJS wrapper around a jquery plugin, this directive still uses chardin.js native attribute lookups: + +``` +
...
+``` + +Additionally this directive provides delegation of chardin.js start and stop events via, help-overlay-start and +help-overlay-stop: + +``` +... +``` + +events being passed are the original chardin.js event objects. + +The example folder contains a modified example of the original chardin.js (i.e., minus the image animate).