Merge pull request madrobby#405 from drale2k/master

Added documentation for the "singleTap" event to README
chennney · Mar 17, 2012 · b5b9b41 · b5b9b41
2 parents 433df87 + 6133eab
commit b5b9b41
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -211,6 +211,16 @@ Tapping:
 $('some selector').tap(function(){ ... });
 ```
 
+Single Tap:
+
+Only use this instead of "tap" if you're using the "doubleTap" event. It it will give you a 250
+ms buffer to be able to differentiate between a single tap and a double tap. Don't use it if you're not
+using "doubleTap" since it will cause a 250 ms delay, which could lead to a bad user experience.
+
+``` js
+$('some selector').singleTap(function(){ ... });
+```
+
 Double-tapping:
 
 ``` js