about summary refs log tree commit homepage
diff options
context:
space:
mode:
authorEric Wong <normalperson@yhbt.net>2009-11-12 20:01:35 -0800
committerEric Wong <normalperson@yhbt.net>2009-11-12 20:01:35 -0800
commit504ab0d4a4c402a90824aaf3c84ef21707e08ad5 (patch)
tree7c08a5938f6fca9b73c9c62e002bb808b5cead2e
parentb5419dc0e819550b5db0bc18579d8243477c53f2 (diff)
downloadupr-504ab0d4a4c402a90824aaf3c84ef21707e08ad5.tar.gz
Update README
-rw-r--r--README37
1 files changed, 26 insertions, 11 deletions
diff --git a/README b/README
index 2589fcd..10b760d 100644
--- a/README
+++ b/README
@@ -1,15 +1,17 @@
 = upr - Upload Progress for Rack
 
 upr is Rack middleware that allows browser-side upload progress
-monitoring.  It is based-on the "mongrel_upload_progress" module, but
-allows any Moneta backing store in addition to DRb.  There is also a
-packaged example for using an ActiveRecord model for Rails.
+monitoring.  It is based on (and should be client-side compatible with)
+several upload progress modules including ones used by leading web
+servers.  It allows any Moneta backing store in addition to DRb.  There
+is also a packaged example for using an ActiveRecord model for Rails.
 
 == Demo
 
-You can see upr it in action at http://upr-demo.bogomips.org/
-It will report the size and SHA1 of the file you've uploaded.
-Much of the demo was stolen from mongrel_upload_progress.
+You can see upr it in action at http://upr-demo.bogomips.org/ It will
+report the size and SHA1 of the file you've uploaded.  Much of the demo
+was stolen from all the existing upload progress examples for other web
+servers.
 
 == Web Server Compatibility
 
@@ -25,14 +27,27 @@ handful of concurrency models:
 For use with Revactor, the use of network-based Moneta stores or DRb is
 only advised if those stores are using Revactor-aware sockets.
 
-== JavaScript/HTML Compatibility
+== JavaScript/CSS/HTML Compatibility
 
-The current developer does not react well with GUIs.  Thus all (R)HTML
-and Prototype JavaScript code was stolen from mongrel_upload_progress.
+The current developer does not react well with GUIs.  Thus all (R)HTML,
+JavaScript and CSS example code was stolen from one of the following:
 
-Contributions to add compatibility for more modern things like JQuery
-and HTML5 are very welcome.
+1. mongrel_upload_progress
+   http://mongrel.rubyforge.org/wiki/UploadProgress
+2. jquery-upload-progress
+   http://github.com/drogus/jquery-upload-progress
+3. mongrel_streaming_upload_progress
+   http://rubyforge.org/pipermail/mongrel-users/2007-July/003747.html
 
+This means our module should also be compatible with any of these
+interfaces.
+
+Contributions to enhance compatibility for more modern things like
+jQuery and HTML5 are very welcome.  We would prefer as much as possible
+to NOT proliferate new AJAX sub-protocols and use existing ones whenever
+possible.  Our current favorite is the Ajax.Pull JavaScript used in
+Ry Dahl's mongrel_streaming_upload_progress because it only requires a
+one extra HTTP request to pull all the status notifications.
 
 == Backend Compatibility