Skip to content

Commit

Permalink
added readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
Dell Sala committed Mar 27, 2012
1 parent f2272f2 commit 16227c7
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
@@ -0,0 +1 @@
/README.html
40 changes: 40 additions & 0 deletions 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);
}
});
});



0 comments on commit 16227c7

Please sign in to comment.