README, fix #7

LICENSE

@@ -175,7 +175,7 @@
 
    END OF TERMS AND CONDITIONS
 
-   Copyright 2021 Holisticon AG
+   Copyright 2024 Holisticon AG
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -5,3 +5,48 @@
 [![Development branches](https://github.com/bpm-crafters/process-engine-api/actions/workflows/development.yml/badge.svg)](https://github.com/bpm-crafters/process-engine-api/actions/workflows/development.yml)
 [![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.bpm-crafters.process-engine-api/process-engine-api/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.bpm-crafters.process-engine-api/process-engine-api)
 
+## Purpose of the library
+
+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.
+
+## Anatomy
+
+The library contains of the following Maven modules:
+
+- process-engine-api: pure API written in Kotlin (100% Java-compatible)
+- engine-adapter/camunda-platform-7-core: core implementation classes for Camunda 7 Platform without additional dependencies
+- engine-adapter/camunda-platform-7-spring-boot-starter: SpringBoot starter for usage of Camunda 7 Platform adapter
+- examples: various example projects showing the usage of the library.
+
+## API
+
+The API consists of different parts independent of each other.
+
+### Process API
+
+The Process API provides functionality, required to control the lifecycle of the processes. It allows to start a new process instance.
+It is intended to be used in outbound adapters of the port/adapter architecture in order to control the process engine from your application.
+
+### Correlation 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 
+appear in the process engine. Since the Task API allows asynchronous processing, we provide a special API to complete tasks.
+
+## Usage
+
+If you want to try the library, please add the following dependency to your Maven `pom.xml`.
+
+```xml
+<dependency>
+  <groupId>dev.bpm-crafters.process-engine-api</groupId>
+  <artifactId>process-engine-api-adapter-camunda-platform-c7-spring-boot-starter</artifactId>
+</dependency>
+```

examples/java-c7/pom.xml

@@ -32,10 +32,6 @@
   </dependencyManagement>
 
   <dependencies>
-    <dependency>
-      <groupId>dev.bpm-crafters.process-engine-api</groupId>
-      <artifactId>process-engine-api</artifactId>
-    </dependency>
     <dependency>
       <groupId>org.camunda.bpm.springboot</groupId>
       <artifactId>camunda-bpm-spring-boot-starter</artifactId>