Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sergeyksv committed Apr 17, 2012
1 parent 5f6f880 commit 9168e61
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions readme.md
Expand Up @@ -29,12 +29,13 @@ function(req, res, next){
Constrouct new ZipFile object, accept global options that will be available for all files

### addFile(options)
Add file into archive. *options* can have following attributes:
* file - path to file
* utf8 - true/false, when true force usage of utf8 for file names
* fast - true/false, force usage zip file option to not put stream info in trailer which allows to stream compression of file reading. When false each file inside archive will be fetched into memory and compressed also as single block
* compress - false/deflate_options_obj, for example set the maximum compression {level:9}
* rootpath - false/somepath, when not false used to build relative names inside archive.
Add file into archive. **options** can have following attributes:

* **file** - path to file
* **utf8** - true/false, when true force usage of utf8 for file names
* **fast** - true/false, force usage zip file option to not put stream info in trailer which allows to stream compression of file reading. When false each file inside archive will be fetched into memory and compressed also as single block
* **compress** - false/deflate_options_obj, for example set the maximum compression {level:9}
* **rootpath** - false/somepath, when not false used to build relative names inside archive.

## getZipStream
Return Read stream
Expand Down

0 comments on commit 9168e61

Please sign in to comment.