manub / scalatest-embedded-kafka

A library that provides an in-memory Kafka instance to run your tests against.
MIT License
295 stars 87 forks source link

Remove names/doc/etc that suggest Scalatest is required #151

Closed crankydillo closed 5 years ago

crankydillo commented 6 years ago

A continuation of the work started for #144. Basically, this library should become usable in more contexts; however, these are still likely test and PoC contexts.. Anyhow, the 2 obvious things to do are rename the project and redo the documentation. Of course, a section on how to use this with ScalaTest would still be nice.

manub commented 6 years ago

I thought about it and I won't be renaming the project for now - the library is getting in the region of approx 20k downloads per month and although most likely the number of users is far lower (CI builds are prone to re-download if caching is not configured properly) I think until 2.0.0 this won't be an option. Reading the docs hopefully should make it clear that the library works also with other test libraries, so for now it will stay like this.

For the docs - I've made it explicit that examples are with ScalaTest in the README. What else do you think should be addressed?

francescopellegrini commented 5 years ago

This is in the work in the new WIP repo.