Added README, COPYING, and APPNOTE.TXT reference. Cleaned up API

documentation.

1 files changed, 29 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..82e8f07
--- /dev/null
+++ b/README
@@ -0,0 +1,29 @@
+ZipStream 0.1.0 README
+======================
+
+Please see the file COPYING for licensing and warranty information.  The
+latest version of this software is available at the following URL:
+
+    http://pablotron.org/software/zipstream-php.
+
+Overview
+========
+A fast and simple streaming zip file downloader for PHP.  Here's a
+simple example:
+
+  # create a new zipstream object
+  $zip = new ZipStream('example.zip');
+
+  # add a file named 'image.jpg'
+  $zip->add_file('image.jpg', file_get_contents('image.jpg'));
+
+  # finish the zip stream
+  $zip->finish();
+
+You can also add comments, modify file timestamps, and customize (or
+disable) the HTTP headers.  See the class file for details.
+
+About the Author
+================
+Paul Duncan <pabs@pablotron.org>
+http://pablotron.org/