Skip to content

Commit

Permalink
Update README.md (#4)
Browse files Browse the repository at this point in the history
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 <zio-assistant[bot]@users.noreply.github.com>
  • Loading branch information
zio-assistant[bot] and zio-assistant[bot] authored Oct 21, 2024
1 parent c87784d commit 223c1f4
Showing 1 changed file with 9 additions and 4 deletions.
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

0 comments on commit 223c1f4

Please sign in to comment.