From 223c1f42acfd0a6d7dabf9f8d74b45085061b883 Mon Sep 17 00:00:00 2001 From: "zio-assistant[bot]" <130037499+zio-assistant[bot]@users.noreply.github.com> Date: Mon, 21 Oct 2024 13:20:22 +0000 Subject: [PATCH] Update README.md (#4) Autogenerated changes after running the `sbt docs/generateReadme` command of the [zio-sbt-website](https://zio.dev/zio-sbt) plugin. I will automatically update the README.md file whenever there is new change for README.md, e.g. - After each release, I will update the version in the installation section. - After any changes to the "docs/index.md" file, I will update the README.md file accordingly. Co-authored-by: ZIO Assistant --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 65d1f3b..59da514 100644 --- a/README.md +++ b/README.md @@ -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" % "" +libraryDependencies += "dev.zio" %% "zio-streams-compress-brotli4j" % "" +libraryDependencies += "dev.zio" %% "zio-streams-compress-bzip2" % "" libraryDependencies += "dev.zio" %% "zio-streams-compress-gzip" % "" +libraryDependencies += "dev.zio" %% "zio-streams-compress-lz4" % "" +libraryDependencies += "dev.zio" %% "zio-streams-compress-tar" % "" libraryDependencies += "dev.zio" %% "zio-streams-compress-zip" % "" libraryDependencies += "dev.zio" %% "zio-streams-compress-zip4j" % "" -libraryDependencies += "dev.zio" %% "zio-streams-compress-tar" % "" -libraryDependencies += "dev.zio" %% "zio-streams-compress-bzip2" % "" libraryDependencies += "dev.zio" %% "zio-streams-compress-zstd" % "" -libraryDependencies += "dev.zio" %% "zio-streams-compress-brotli" % "" -libraryDependencies += "dev.zio" %% "zio-streams-compress-lz4" % "" ``` +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.