Permalink
Browse files

Added real readme.

  • Loading branch information...
1 parent a938e3d commit 94d9ca66ab7236012c58db67ff353f881e9fa891 @jwmcpeak committed Mar 14, 2012
Showing with 25 additions and 0 deletions.
  1. +25 −0 README.md
View
@@ -0,0 +1,25 @@
+# EventShim
+
+## A Basic Standards DOM Event API for IE8
+EventShim is a shim that adds support for addEventListener(), removeEventListener(), and standard Event object properties to IE8's event model.
+
+### Why
+To write standards-based event code now in IE8.
+
+### How
+The right way: by modifying the DispEventObj's prototype, as well as the HTMLDocument and Element DOM interface prototypes. This approach allows you to "write once."
+
+### Quick Start
+EventShim is easy to implement.
+
+#### Step 1: Clone the repo
+ $ git clone git@github.com:jwmcpeak/EventShim
+
+#### Step 2: Load the Script
+ <script src="eventShim.js"></script>
+
+#### API
+None at the moment. The goal of EventShim is to make writing cross-browser event code painless and transparent.
+
+#### Notes
+- There is no capture. It's IE, remember?

0 comments on commit 94d9ca6

Please sign in to comment.