From 3098dc06d4cd30ddd690f3653ed0de7ab80270d1 Mon Sep 17 00:00:00 2001
From: Robert Karlsson <robert.karlsson1@gmail.com>
Date: Mon, 2 Dec 2024 14:55:24 +0900
Subject: [PATCH] Updated read me with usage

---
 kafka-event-queue/README.md | 28 +++++++++++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)

diff --git a/kafka-event-queue/README.md b/kafka-event-queue/README.md
index f776be837..690e71059 100644
--- a/kafka-event-queue/README.md
+++ b/kafka-event-queue/README.md
@@ -16,7 +16,33 @@ https://kafka.apache.org/
 
 ## kafka-event-queue
 
-Provides ability to consume messages from Kafka
+Provides ability to consume messages from Kafka.
+
+## Usage
+
+To use it in an event handler prefix the event with `kafka` followed by the topic. 
+
+Example:
+```json
+{
+    "name": "kafka_test_event_handler",
+    "event": "kafka:conductor-event",
+    "actions": [
+      {
+        "action": "start_workflow",
+        "start_workflow": {
+          "name": "workflow_triggered_by_kafka",
+          "input": {
+            "inlineValue": 1
+          }
+        },
+        "expandInlineJSON": true
+      }
+    ],
+    "active": true
+}
+```
+
 
 ## Configuration