summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorpabs <pabs@pablotron.org>2007-08-23 03:51:16 -0400
committerpabs <pabs@pablotron.org>2007-08-23 03:51:16 -0400
commitaeb68198d5b8a15ccc8f4a3798a239ae6f74d374 (patch)
treef49a1923d25f6040a7a9dc95efc6d68639f7ee55 /README
parentab07bb311ae7f8781da42ee79d1e441718521a5e (diff)
downloadzipstream-php-aeb68198d5b8a15ccc8f4a3798a239ae6f74d374.tar.bz2
zipstream-php-aeb68198d5b8a15ccc8f4a3798a239ae6f74d374.zip
Added README, COPYING, and APPNOTE.TXT reference. Cleaned up API
documentation.
Diffstat (limited to 'README')
-rw-r--r--README29
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/