Adding license file and some readme

tcz · tcz · commit 16d6161f3fb5 · 2011-08-01T02:50:31.000+02:00
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,24 @@
+Copyright (c) 2011, Zoltan Toth-Czifra
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the <organization> nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/README.md b/README.md
@@ -0,0 +1,33 @@
+## Introduction ##
+
+Js-secure-uploader is a framework-independent Javascript library that allows you to upload files to a remote server with client-side integrity checking.
+
+It works with the latest HTML5 technologies (File API, Web workers) therefore its browser support is very limited, currently only works with Chrome.
+
+It is capable to upload really big files to be combined on server side. It is because js-secure-uploader creates small chunks of the files, and calculates hash for each (and the entire file too).
+
+At the moment only SHA1 hash is supported, but in the future other integrity checking methods (CRC32, MD5) are coming.
+
+For usage hint see examples. If you happen to miss the comment in the PHP example: DON'T use it in production.
+
+## Things that are missing ##
+
+...but will come soon.
+
+- Firefox support
+Once this bug is fixed in FF, it should work there too: https://bugzilla.mozilla.org/show_bug.cgi?id=664783
+I am planning to add support anywazs with async file read in the worker, but it's a bit ugly.
+
+- Optimizations
+“The First Rule of Program Optimization: Don't do it. The Second Rule of Program Optimization (for experts only!): Don't do it yet.” - Michael A. Jackson
+I am currently in the "yet" phase.
+
+- More hash algorithms - you can open issues if you need any. CRC32 and MD5 are planned.
+
+- More tests - if js-test-driver would not be so buggy, I could have written all the tests for all objects. But it is buggy.
+
+- More user interface magic
+
+## License ##
+
+Js-secure-uploader comes for free, open-sourced, with the new (3 clause) BSD license that you can read in the LICENSE file.
