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.

Sign up for GitHub

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 #27

Merged
merged 1 commit into from
Jan 8, 2024
Merged

Update README.md #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 28 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,39 @@
# Brotli filter for play

[![Maven Central](https://index.scala-lang.org/guardian/play-brotli-filter/play-brotli-filter/latest-by-scala-version.svg)](https://index.scala-lang.org/guardian/play-brotli-filter/play-brotli-filter)
[![License](https://img.shields.io/:license-Apache%202.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)

A [Brotli](https://opensource.googleblog.com/2015/09/introducing-brotli-new-compression.html) filter for the [playframework](https://www.playframework.com/)

* A [Brotli](https://opensource.googleblog.com/2015/09/introducing-brotli-new-compression.html) filter for the [Play framework](https://www.playframework.com/)
* A [Brotli](https://opensource.googleblog.com/2015/09/introducing-brotli-new-compression.html) compression `Operator` and a decompression `Operator` for [Akka streams](https://doc.akka.io/docs/akka/current/stream/stream-flows-and-basics.html)
* A [Brotli](https://opensource.googleblog.com/2015/09/introducing-brotli-new-compression.html) compression `Operator` and a decompression `Operator` for [Apache Pekko](https://pekko.apache.org/) streams

## Install

Add `play-brotli-filter` as a dependency:
## Install

```scala
libraryDependencies ++= Seq(
"com.gu" %% "play-brotli-filter" % "0.9",
)
```
Add as a dependency:

* Play **3.0** use [![play-v30-brotli-filter](https://index.scala-lang.org/guardian/play-brotli-filter/play-v30-brotli-filter/latest-by-scala-version.svg)](https://index.scala-lang.org/guardian/play-brotli-filter/play-v30-brotli-filter/)
```scala
libraryDependencies += "com.gu" %% "play-v30-brotli-filter" % "[latest version number]"
```
* Play **2.9** use [![play-v29-brotli-filter](https://index.scala-lang.org/guardian/play-brotli-filter/play-v29-brotli-filter/latest-by-scala-version.svg)](https://index.scala-lang.org/guardian/play-brotli-filter/play-v29-brotli-filter/)
```scala
libraryDependencies += "com.gu" %% "play-v29-brotli-filter" % "[latest version number]"
```
* Play **2.8** use [![play-v28-brotli-filter](https://index.scala-lang.org/guardian/play-brotli-filter/play-v28-brotli-filter/latest-by-scala-version.svg)](https://index.scala-lang.org/guardian/play-brotli-filter/play-v28-brotli-filter/)
```scala
libraryDependencies += "com.gu" %% "play-v28-brotli-filter" % "[latest version number]"
```

* Akka use [![akka-stream-brotli](https://index.scala-lang.org/guardian/play-brotli-filter/akka-stream-brotli/latest-by-scala-version.svg)](https://index.scala-lang.org/guardian/play-brotli-filter/akka-stream-brotli/)
```scala
libraryDependencies += "com.gu" %% "akka-stream-brotli" % "[latest version number]"
```

* Pekko use [![pekko-stream-brotli](https://index.scala-lang.org/guardian/play-brotli-filter/pekko-stream-brotli/latest-by-scala-version.svg)](https://index.scala-lang.org/guardian/play-brotli-filter/pekko-stream-brotli/)
```scala
libraryDependencies += "com.gu" %% "pekko-stream-brotli" % "[latest version number]"
```

## Configure

Expand Down
Loading