Starting to work on readme. Note that this is not ready for use yet.

kpozin · Apr 23, 2011 · f722001 · f722001
1 parent 8d788ac
commit f722001
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,16 @@
+Description
+-----------
+
+This jQuery plugin provides access to the `onprogress` event of the `XMLHttpRequest` object available
+in modern browsers. It has been tested in recent versions of Chrome/Chromium and in Firefox 4.
+
+Note: this is not yet ready for use. I'm still working out a few issues with providing the right arguments to the
+event handlers.
+
+How to use
+----------
+
+The plugin exposes the `onprogress` event in two ways:
+
+1.
+2.