diff --git a/tools/README.md b/tools/README.md index d5d9d244a..ed50c23f0 100644 --- a/tools/README.md +++ b/tools/README.md @@ -2,6 +2,8 @@ This folder contains applications that are useful for exploration of your Kafka cluster, or instrumentation. Some of these tools mirror tools that ship with Kafka, but these tools won't require installing the JVM to function. +We will make an effort to keep their APIs stable, but they are not specifically +covered by Sarama's semantic versioning guarantees. - [kafka-console-producer](./kafka-console-producer): a command line tool to produce a single message to your Kafka custer. - [kafka-console-consumer](./kafka-console-consumer): a command line tool to consume partitions of a topic on your Kafka cluster.