MOAR READING!

Author: furf

README.md

@@ -1 +1,20 @@
-Check out some live examples at <http://furf.com/exp/touch-punch/>
+=== jQuery UI Touch Punch ===
+This little library was designed to punch in touch events to jQuery UI. It provides touch proxies to the major mouse events. 
+
+This punch was written as a quick demonstration for a friend and I have not used it in production. Since I posted it, a number of people have started using it. (This was an unexpected consequence that I really should have expected!)
+
+Check out some live examples at <http://furf.com/exp/touch-punch/> (and use a touch-capable device, silly).
+
+There have been a number of issues logged and I will do what I can to mitigate them. Since this library is not a priority for me, it has taken a long time for me to respond. (I will try to be better about that now that so many people are seeing benefit from the library.)
+
+That said, there may be use cases that I cannot simply patch due to the limitations of jQuery UI. The jQuery and jQuery UI teams have done an amazing job of updating their code with great frequency. I do not have the manpower to keep up with them or properly test for regressions in all combinations.
+
+=== YMMV ===
+If you use my punch and it works, awesome! If it doesn't, please let me know by filing a proper issue with detailed information, including jQuery and jQuery UI versions, and an example where the code breaks. Better yet, fork this repo and hack away! If you come up with a fix, post it and submit a pull request. (Please include a broken example that I can test against.) As I said, I will do my best to keep this library updated more frequently.
+
+Cheers!
+
+furf
+
+
+