Browse Source

Update READMEs

Willem van Bergen 10 years ago
parent
commit
3e02f29af4
2 changed files with 8 additions and 0 deletions
  1. 1 0
      README.md
  2. 7 0
      tools/README.md

+ 1 - 0
README.md

@@ -11,6 +11,7 @@ Sarama is an MIT-licensed Go client library for Apache Kafka 0.8 (and later).
 - API documentation and example are available via godoc at https://godoc.org/github.com/Shopify/sarama.
 - API documentation and example are available via godoc at https://godoc.org/github.com/Shopify/sarama.
 - Mocks for testing are available in the [mocks](./mocks) subpackage.
 - Mocks for testing are available in the [mocks](./mocks) subpackage.
 - The [examples](./examples) directory contains more elaborate example applications.
 - The [examples](./examples) directory contains more elaborate example applications.
+- The [tools](./tools) directory contains command line tools that can be useful for testing, diagnostics, and instrumentation.
 - There is a google group for Kafka client users and authors at https://groups.google.com/forum/#!forum/kafka-clients
 - There is a google group for Kafka client users and authors at https://groups.google.com/forum/#!forum/kafka-clients
 
 
 ### Compatibility and API stability
 ### Compatibility and API stability

+ 7 - 0
tools/README.md

@@ -0,0 +1,7 @@
+# Sarama tools
+
+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.
+
+- [kafka-console-producer](./kafka-console-producer): a command line tool to produce a single message to your Kafka custer.
+- [kafka-console-partitionconsumer](./kafka-console-producer): a command line tool to consume a single partition fo a topic on your Kafka cluster.