Skip to content

Commit

Permalink
Add migration note
Browse files Browse the repository at this point in the history
  • Loading branch information
julik committed Apr 17, 2024
1 parent 56dfbda commit 1b91ec8
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@

Allows streaming, non-rewinding ZIP file output from Ruby.

`zip_kit` is a successor to and continuation of [zip_tricks](https://github.com/WeTransfer/zip_tricks), which
was inspired by [zipline](https://github.com/fringd/zipline). I am grateful to WeTransfer for allowing me
to develop zip_tricks and for sharing it with the community.
> [!IMPORTANT]
> `zip_kit` is a successor to and continuation of [zip_tricks](https://github.com/WeTransfer/zip_tricks)
> I am grateful to WeTransfer for allowing me to develop zip_tricks and for sharing it with the community.
Allows you to write a ZIP archive out to a `File`, `Socket`, `String` or `Array` without having to rewind it at any
point. Usable for creating very large ZIP archives for immediate sending out to clients, or for writing
Expand All @@ -22,6 +22,13 @@ Check out [the implementation details](IMPLEMENTATION_DETAILS.md) on the design
we have a separate [reference](RUBYZIP_DIFFERENCES.md) on why you might want to use ZipKit over
Rubyzip and vice versa.

## Migrating from zip_tricks

If you want to migrate your code from zip_tricks to zip_kit, all you need to do is a blanket replacement in your code.
Swap out the `ZipTricks` constant for `ZipKit` and you should be in business. All of the API available in ZipTricks 5.x
still works as of ZipKit 6.x and will stay working. If something in your project still depends on zip_tricks you can use
both gems inside of the same "apex" project - there will be no conflicts.

## Requirements

Ruby 2.6+ syntax support is required, as well as a a working zlib (all available to jRuby as well).
Expand Down

0 comments on commit 1b91ec8

Please sign in to comment.