root
/
rubyzip
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[README] Updating README

This commit is contained in:
kellydunn 2012-03-12 16:31:55 -07:00
parent 265409fd66
commit 69ba05dd72
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -14,6 +14,24 @@ To run the unit tests you need to have test::unit installed
rake test
[![Build Status](https://secure.travis-ci.org/aussiegeek/rubyzip.png)](http://travis-ci.org/aussiegeek/rubyzip)
Configuration
-------------
By default, rubyzip will not overwrite files if they already exist inside of the extracted path. To change this behavior, you may specify a configuration option like so:
```
Zip.options[:on_exists_proc] = true
```
If you're using rubyzip with rails, consider placing this snippet of code in an initializer file such as `config/initializers/rubyzip.rb`
Additionally, if you want to configure rubyzip to overwrite pre-existing files while creating a .zip file, you can do so with the following:
```
Zip.options[:continue_on_exists_proc] = true
```
Documentation
-------------
@ -68,4 +86,4 @@ Thomas Sondergaard (thomas at sondergaard.cc)
Technorama Ltd. (oss-ruby-zip at technorama.net)
extra-field support contributed by Tatsuki Sugiura (sugi at nemui.org)
extra-field support contributed by Tatsuki Sugiura (sugi at nemui.org)