From 16227c7fc993bf752e953aaac1e0cffb02bcab03 Mon Sep 17 00:00:00 2001
From: Dell Sala <dell@dellsala.com>
Date: Tue, 27 Mar 2012 12:57:34 -0400
Subject: [PATCH] added readme file

---
 .gitignore |  1 +
 README.md  | 40 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 41 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..4814f46
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+/README.html
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..241cf92
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+jQuery Asynchronous Upload Plugin
+=================================
+
+What is it?
+----------
+Turns an element into an asynchronous file upload trigger.
+
+* bare-bones ajax file upload functionality
+* no built-in ui (other than a required trigger element)
+* hooks for attaching your own ui interactions
+* fully customizable server-side response handling/formatting
+* html4 iframe implementation only (no progress reporting)
+* single file upload per trigger
+
+
+How to Use it
+-------------
+
+###HTML
+    <input type="button" id="myUploadButton" value="Upload a File">
+
+###JavaScript
+
+    $(function () {
+     
+        $('#myUploadButton').uploader({
+            url : '/some-upload-handler.php',
+            inputName : 'my_upload_file', 
+            onStart : function () {
+                $('body').append('Upload started...');
+            },
+            onComplete : function (response) {
+                $('body').append('Upload finished. Response: '+response);
+            }
+        });
+     
+    });
+
+
+