diff --git a/README.md b/README.md index 2cffbc0..f8c4fe4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,25 @@ # zb-dmn-extension -Zeebe task worker for DMN. It uses the Camunda DMN engine to evaluate decisions. The decisions are read from a directory (default 'repo'). +Zeebe task worker for DMN. It uses the Camunda DMN engine to evaluate decisions. The decisions are read from local directory. * register for tasks of type 'DMN' -* task requires a header 'decisionRef' which holds the id of the decision to evaluate -* task is completed with payload 'result' which contains the decision result +* required task header 'decisionRef' => id of the decision to evaluate +* completes task with payload 'result' which contains the complete decision result + +## How to build + +Build with Maven + +`mvn clean install` + +## How to run + +Execute the JAR file via + +`java -jar target/zeebe-dmn.jar` + +## How to configure + +You can provide a properties file `application.properties` to configure the Zeebe client and set + +* the directory of the DMN repository (default: 'repo') +* the task topic (default: 'default-topic')