diff --git a/README.md b/README.md index f8477920..405dd09e 100644 --- a/README.md +++ b/README.md @@ -9,17 +9,22 @@ This library provides a modern engine-agnostic API which can be used to implement process applications. By providing a set of adapters to relevant process engines (Camunda Platform 7, Camunda Platform 8, etc...) the library enforces separation of -the integration of process engine from the selection of the used engine. This approach makes the migration between engines -easier. +the integration of process engine from the selection of the used engine. This approach fosters an easy migration between engines +and tries to achieve to support migrations with minimal (or even no) code modifications. ## Anatomy The library contains of the following Maven modules: - `process-engine-api`: pure API written in Kotlin (100% Java-compatible) +- `process-engine-api-adapter-commons`: commons for adapter implementation, which are independent of the selected engine - `process-engine-api-adapter-camunda-platform-7-embedded-core`: core implementation classes for Camunda 7 Platform without additional dependencies - `process-engine-api-adapter-camunda-platform-7-embedded-spring-boot-starter`: SpringBoot starter for usage of Camunda 7 Platform adapter -- `examples`: various example projects showing the usage of the library. +- `process-engine-api-adapter-camunda-platform-8-core`: core implementation classes for Camunda 8 Platform without additional dependencies +- `process-engine-api-adapter-camunda-platform-8-spring-boot-starter`: SpringBoot starter for usage of Camunda 8 Platform adapter +- `examples/java-common-fixture`: A project that is used independent of selected process engine adapter +- `examples/java-c7`: Project with embedded C7 engine and a simple process scenario +- `examples/java-c8`: Project with configuration of SaaS C8 engine and a simple process scenario ## API @@ -35,6 +40,12 @@ It is intended to be used in outbound adapters of the port/adapter architecture The Correlation API provides functionality to correlate messages and signals with running process instances. It is intended to be used in outbound adapters of the port/adapter architecture in order to control the process engine from your application. +### Signal API + +The Correlation API provides functionality to correlate messages and signals with running process instances. +It is intended to be used in outbound adapters of the port/adapter architecture in order to control the process engine from your application. + + ### Task API The Task API provides functionality to deal with tasks. The task handlers can be registered and get invoked when tasks @@ -42,7 +53,7 @@ appear in the process engine. Since the Task API allows asynchronous processing, ## Usage -If you want to try the library, please add the following dependency to your Maven `pom.xml`. +If you want to try the library with Camunda 7, please add the following dependency to your Maven `pom.xml`. ```xml @@ -50,3 +61,12 @@ If you want to try the library, please add the following dependency to your Mave process-engine-api-adapter-camunda-platform-c7-embedded-spring-boot-starter ``` + +If you want to try the library with Camunda 8, please add the following dependency to your Maven `pom.xml`. + +```xml + + dev.bpm-crafters.process-engine-api + process-engine-api-adapter-camunda-platform-c8-spring-boot-starter + +```