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

Tidy up updating notes in README.

This commit is contained in:
Robert Haines 2022-01-11 22:21:20 +00:00
parent 7f7c4ca194
commit b1b82bbd9e
1 changed files with 1 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -10,7 +10,7 @@ Rubyzip is a ruby library for reading and writing zip files.
## Important notes
### Version 3.0
### Updating to version 3.0
The public API of some classes has been modernized to use named parameters for optional arguments. Please check your usage of the following Rubyzip classes:
* `File`
@ -18,17 +18,6 @@ The public API of some classes has been modernized to use named parameters for o
* `InputStream`
* `OutputStream`
### Older versions (pre 2.0)
The Rubyzip interface has changed!!! No need to do `require "zip/zip"` and `Zip` prefix in class names removed.
If you have issues with any third-party gems that require an old version of rubyzip, you can use this workaround:
```ruby
gem 'rubyzip', '>= 1.0.0' # will load new rubyzip version
gem 'zip-zip' # will load compatibility for old rubyzip API.
```
## Requirements
Version 3.x requires at least Ruby 2.5.