From 5c20309afb8d9f96dba04b1a4d05005859fb040e Mon Sep 17 00:00:00 2001 From: Shubhang Balkundi Date: Fri, 5 Apr 2024 13:20:09 +0530 Subject: [PATCH] Update README.md --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 34d8099..47bf414 100644 --- a/README.md +++ b/README.md @@ -381,6 +381,8 @@ type ConsumerConfig struct { MaxPollIntervalMS int // Kafka Failure detection interval in milliseconds } ``` +> For more info on what the config keys and values mean please check the below link ( not all config keys are included in Ziggurat, they might be added in the future ) +https://github.com/confluentinc/librdkafka/blob/master/CONFIGURATION.md #### Practical example on setting the `ConsumerCount` value The `ConsumerCount` value is used to control the concurrency of your handler execution, a higher value does not mean better performance, for an optimum performance please set it to the number of partitions you are consuming from. @@ -405,9 +407,6 @@ ziggurat.Event{ } ``` -> For more info on what the config keys and values mean please check the below link -https://github.com/confluentinc/librdkafka/blob/master/CONFIGURATION.md - ## How to use the ziggurat Event Router First of all understand if you need a router, a router is required only if you have different handlers for different type of events, if your application just consumes from one topic, and you just want to handle all events in the same way then a router is not required, you can just pass a `ziggurat.HandlerFunc` OR a type that implements the `ziggurat.Handler` interface directly. A router lets you handle different events in a different ways by defining regex rules.