docs(events): update readme documentation

Signed-off-by: Jonas Beck <dev@jonasbeck.dk>

plugins/events-backend-module-kafka/README.md

@@ -2,65 +2,107 @@
 
 Welcome to the `events-backend-module-kafka` backend module!
 
-This package is a module for the `events-backend` backend plugin and extends the events system with an `KafkaConsumingEventPublisher.`
+This package is a module for the `events-backend` backend plugin and extends the events system with a `KafkaConsumingEventPublisher` and `KafkaPublishingEventConsumer`
 
-This event publisher will allow you to receive events from an Kafka queue and will publish these to the used `EventsService` implementation.
+This module provides two-way integration with Kafka:
+
+- **KafkaConsumingEventPublisher**: Receives events from Kafka queues and publishes them to the Backstage events system
+- **KafkaPublishingEventConsumer**: Consumes events from Backstage and publishes them to Kafka queues
 
 ## Configuration
 
-To set up Kafka queues, you need to configure the following values:
+To set up Kafka integration, you need to configure one or both of the following components:
+
+### KafkaConsumingEventPublisher Configuration
+
+To receive events from Kafka queues and publish them to Backstage:
 
 ```yaml
 events:
   modules:
     kafka:
       kafkaConsumingEventPublisher:
-        clientId: your-client-id # (Required) Client ID used by Backstage to identify when connecting to the Kafka cluster.
-        brokers: # (Required) List of brokers in the Kafka cluster to connect to.
-          - broker1
-          - broker2
-        topics:
-          - topic: 'backstage.topic' # (Required) Replace with actual topic name as expected by subscribers
-            kafka:
-              topics: # (Required) The Kafka topics to subscribe to.
-                - topic1
-              groupId: your-group-id # (Required) The GroupId to be used by the topic consumers.
+        production: # Instance name, will be included in logs
+          clientId: your-client-id # (Required) Client ID used by Backstage to identify when connecting to the Kafka cluster.
+          brokers: # (Required) List of brokers in the Kafka cluster to connect to.
+            - broker1
+            - broker2
+          topics:
+            - topic: 'backstage.topic' # (Required) Replace with actual topic name as expected by subscribers
+              kafka:
+                topics: # (Required) The Kafka topics to subscribe to.
+                  - topic1
+                groupId: your-group-id # (Required) The GroupId to be used by the topic consumers.
+```
+
+### KafkaPublishingEventConsumer Configuration
+
+To publish events from Backstage to Kafka queues, you can configure the `KafkaPublishingEventConsumer`:
+
+```yaml
+events:
+  modules:
+    kafka:
+      kafkaPublishingEventConsumer:
+        production: # Instance name, will be included in logs
+          clientId: your-client-id # (Required) Client ID used by Backstage to identify when connecting to the Kafka cluster.
+          brokers: # (Required) List of brokers in the Kafka cluster to connect to.
+            - broker1
+            - broker2
+          topics:
+            - topic: 'catalog.entity.created' # (Required) The Backstage topic to consume from
+              kafka:
+                topic: kafka-topic-name # (Required) The Kafka topic to publish to
 ```
 
 For a complete list of all available fields that can be configured, refer to the [config.d.ts file](./config.d.ts).
 
 ### Optional SSL Configuration
 
-If your Kafka cluster requires SSL, you can configure it as follows:
+If your Kafka cluster requires SSL, you can configure it for both `kafkaConsumingEventPublisher` and `kafkaPublishingEventConsumer` instances:
 
 ```yaml
 events:
   modules:
     kafka:
       kafkaConsumingEventPublisher:
-        ssl:
-          rejectUnauthorized: true # (Optional) If true, the server certificate is verified against the list of supplied CAs.
-          ca: [path/to/ca-cert] # (Optional) Array of trusted certificates in PEM format.
-          key: path/to/client-key # (Optional) Private key in PEM format.
-          cert: path/to/client-cert # (Optional) Public x509 certificate in PEM format.
+        production:
+          # ... other configuration ...
+          ssl:
+            rejectUnauthorized: true # (Optional) If true, the server certificate is verified against the list of supplied CAs.
+            ca: [path/to/ca-cert] # (Optional) Array of trusted certificates in PEM format.
+            key: path/to/client-key # (Optional) Private key in PEM format.
+            cert: path/to/client-cert # (Optional) Public x509 certificate in PEM format.
+      kafkaPublishingEventConsumer:
+        production:
+          # ... other configuration ...
+          ssl:
+            # Same SSL configuration options as above
 ```
 
 ### Optional SASL Authentication Configuration
 
-If your Kafka cluster requires `SASL` authentication, you can configure it as follows:
+If your Kafka cluster requires SASL authentication, you can configure it for both components:
 
 ```yaml
 events:
   modules:
     kafka:
       kafkaConsumingEventPublisher:
-        sasl:
-          mechanism: 'plain' # SASL mechanism ('plain', 'scram-sha-256' or 'scram-sha-512')
-          username: your-username # SASL username
-          password: your-password # SASL password
+        production:
+          # ... other configuration ...
+          sasl:
+            mechanism: 'plain' # SASL mechanism ('plain', 'scram-sha-256' or 'scram-sha-512')
+            username: your-username # SASL username
+            password: your-password # SASL password
+      kafkaPublishingEventConsumer:
+        production:
+          # ... other configuration ...
+          sasl:
+            # Same SASL configuration options as above
 ```
 
-This section includes optional `SSL` and `SASL` authentication configuration for enhanced security.
+These SSL and SASL configurations apply to both Kafka components and provide enhanced security for your Kafka connections.
 
 ## Installation