Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #4

Merged
merged 1 commit into from
Oct 21, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,21 @@ archive formats with [ZIO Streams](https://zio.dev).
In order to use this library, we need to add one of the following line in our `build.sbt` file:

```sbt
libraryDependencies += "dev.zio" %% "zio-streams-compress-brotli" % "<version>"
libraryDependencies += "dev.zio" %% "zio-streams-compress-brotli4j" % "<version>"
libraryDependencies += "dev.zio" %% "zio-streams-compress-bzip2" % "<version>"
libraryDependencies += "dev.zio" %% "zio-streams-compress-gzip" % "<version>"
libraryDependencies += "dev.zio" %% "zio-streams-compress-lz4" % "<version>"
libraryDependencies += "dev.zio" %% "zio-streams-compress-tar" % "<version>"
libraryDependencies += "dev.zio" %% "zio-streams-compress-zip" % "<version>"
libraryDependencies += "dev.zio" %% "zio-streams-compress-zip4j" % "<version>"
libraryDependencies += "dev.zio" %% "zio-streams-compress-tar" % "<version>"
libraryDependencies += "dev.zio" %% "zio-streams-compress-bzip2" % "<version>"
libraryDependencies += "dev.zio" %% "zio-streams-compress-zstd" % "<version>"
libraryDependencies += "dev.zio" %% "zio-streams-compress-brotli" % "<version>"
libraryDependencies += "dev.zio" %% "zio-streams-compress-lz4" % "<version>"
```

For Brotli you can choose between the 'brotli' and the 'brotli4j' version. The first is based on the official Java
library but only does decompression. The second is based on [Brotli4J](https://github.com/hyperxpro/Brotli4j) which does
compression and decompression.

For ZIP files you can choose between the 'zip' and the 'zip4j' version. The first allows you to tweak the compression
level, while the second allows you work with password-protected ZIP files.

Expand Down