File tree 1 file changed +10
-3
lines changed
1 file changed +10
-3
lines changed Original file line number Diff line number Diff line change 5
5
6
6
Allows streaming, non-rewinding ZIP file output from Ruby.
7
7
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.
11
11
12
12
Allows you to write a ZIP archive out to a ` File ` , ` Socket ` , ` String ` or ` Array ` without having to rewind it at any
13
13
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
22
22
we have a separate [ reference] ( RUBYZIP_DIFFERENCES.md ) on why you might want to use ZipKit over
23
23
Rubyzip and vice versa.
24
24
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
+
25
32
## Requirements
26
33
27
34
Ruby 2.6+ syntax support is required, as well as a a working zlib (all available to jRuby as well).
You can’t perform that action at this time.
0 commit comments