Skip to content

Commit

Permalink
Tidy up updating notes in README.
Browse files Browse the repository at this point in the history
  • Loading branch information
hainesr committed Jan 11, 2022
1 parent 36a6136 commit aad176f
Showing 1 changed file with 1 addition and 12 deletions.
13 changes: 1 addition & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,14 @@ 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`
* `Entry`
* `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.
Expand Down

0 comments on commit aad176f

Please sign in to comment.