Skip to content

Commit 76c70d3

Browse files
authored
Update README.md
1 parent 3c542ca commit 76c70d3

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# scalatest-embedded-kafka
2-
A library that provides an in-memory Kafka broker to run your ScalaTest specs against. It uses Kafka 0.11.0.0 and ZooKeeper 3.4.9.
3-
4-
The version supporting Kafka 0.8.x can be found [here](https://github.com/manub/scalatest-embedded-kafka/tree/kafka-0.8) - *this is no longer actively supported, although I'll be happy to accept PRs and produce releases.*
2+
A library that provides an in-memory Kafka broker to run your ScalaTest specs against. It uses Kafka 1.0.0 and ZooKeeper 3.4.10.
53

64
Inspired by https://github.com/chbatey/kafka-unit
75

@@ -21,10 +19,11 @@ scalatest-embedded-kafka is available on Bintray and Maven Central, compiled for
2119
* Scala 2.10 is supported until `0.10.0`
2220
* Scala 2.11 is supported for all versions
2321
* Scala 2.12 is supported from `0.11.0`.
22+
2423

2524
### How to use
2625

27-
* In your `build.sbt` file add the following dependency: `"net.manub" %% "scalatest-embedded-kafka" % "0.16.0" % "test"`
26+
* In your `build.sbt` file add the following dependency: `"net.manub" %% "scalatest-embedded-kafka" % "1.0.0" % "test"`
2827
* Have your `Spec` extend the `EmbeddedKafka` trait.
2928
* Enclose the code that needs a running instance of Kafka within the `withRunningKafka` closure.
3029
```scala
@@ -186,7 +185,7 @@ It takes care of instantiating and starting your streams as well as closing them
186185

187186
### How to use
188187

189-
* In your `build.sbt` file add the following dependency: `"net.manub" %% "scalatest-embedded-kafka-streams" % "0.15.1" % "test"`
188+
* In your `build.sbt` file add the following dependency: `"net.manub" %% "scalatest-embedded-kafka-streams" % "1.0.0" % "test"`
190189
* Have a look at the [example test](kafka-streams/src/test/scala/net/manub/embeddedkafka/streams/ExampleKafkaStreamsSpec.scala)
191190
* For most of the cases have your `Spec` extend the `EmbeddedKafkaStreamsAllInOne` trait. This offers both streams management and easy creation of consumers for asserting resulting messages in output/sink topics.
192191
* If you only want to use the streams management without the test consumers just have the `Spec` extend the `EmbeddedKafkaStreams` trait.

0 commit comments

Comments
 (0)