Skip to content

Commit 1b91ec8

Browse files
committed
Add migration note
1 parent 56dfbda commit 1b91ec8

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

+10-3
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55

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

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

25+
## Migrating from zip_tricks
26+
27+
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.
28+
Swap out the `ZipTricks` constant for `ZipKit` and you should be in business. All of the API available in ZipTricks 5.x
29+
still works as of ZipKit 6.x and will stay working. If something in your project still depends on zip_tricks you can use
30+
both gems inside of the same "apex" project - there will be no conflicts.
31+
2532
## Requirements
2633

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

0 commit comments

Comments
 (0)