diff --git a/README.md b/README.md index 089d5df64..0ceae9e74 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,10 @@ This project allows you to unit test your Camunda Platform 8 BPMN processes. It will start a Zeebe test engine and provide you with a set of assertions you can use to verify your process behaves as expected. -> [!Note] -> Heads up! We are building a new Java testing library for Camunda 8.6+. The new library will replace Zeebe Process Test eventually. -> New features: Access to Camunda's new REST API, official Spring integration, process coverage, improved UX, and more ([ref](https://github.com/camunda/issues/issues/751)). -> Stay tuned for updates. 🚀 +> [!NOTE] +> Heads up! We created a new Java testing library for Camunda 8.6+: Camunda Process Test. The new library will replace Zeebe Process Test eventually. +> New features: Access to Camunda's new REST API, official Spring integration, improved UX, and more. +> See the [documentation](https://docs.camunda.io/docs/apis-tools/testing/getting-started/) on how to get started. 🚀 ## Prerequisites @@ -16,8 +16,6 @@ and provide you with a set of assertions you can use to verify your process beha * Java 8+ and Docker when running using testcontainers (`zeebe-process-test-extension-testcontainer`) * JUnit 5 -**NOTE**: If you use **Spring** and want to write tests, please use `spring-zeebe-test` as a wrapper around Zeebe Process Test to hook everything into the Spring lifecycle. See [Spring Zeebe: Writing test cases](https://github.com/camunda-community-hub/spring-zeebe#writing-test-cases) for details. - ## Getting Started ### Dependency @@ -65,7 +63,11 @@ Using Maven profiles you can also [switch the test dependencies based on the ava ### Spring support -If you use the Spring framework or Spring Boot and you want to write tests, please use `spring-zeebe-test` as a wrapper around this library. This will hook everything into the Spring lifecycle. See [Spring Zeebe: Writing test cases](https://github.com/camunda-community-hub/spring-zeebe#writing-test-cases) for details. +If you use [Spring-Zeebe](https://github.com/camunda-community-hub/spring-zeebe) (community-maintained project) and want to write tests, please use `spring-zeebe-test` as a wrapper around Zeebe Process Test to hook everything into the Spring lifecycle. See [Spring Zeebe: Writing test cases](https://github.com/camunda-community-hub/spring-zeebe#writing-test-cases) for details. + +> [!IMPORTANT] +> Zeebe Process Test has no integration for the [Camunda Spring SDK](https://docs.camunda.io/docs/apis-tools/spring-zeebe-sdk/getting-started/). You could still use the library but without hooking into the Spring lifecycle. +> Alternatively, you could migrate to the new [Camunda Process Test](https://docs.camunda.io/docs/apis-tools/testing/getting-started/) library that has support for the Spring SDK. ### Annotation