From b3c13b7aefa8b529e8a836dc209a411d677ee3e8 Mon Sep 17 00:00:00 2001
From: Emil Stolarsky <emil.stolarsky@gmail.com>
Date: Wed, 8 Jul 2015 15:39:23 -0400
Subject: [PATCH] Adds README for Kafka consumer plugin

---
 plugins/kafka_consumer/README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 plugins/kafka_consumer/README.md

diff --git a/plugins/kafka_consumer/README.md b/plugins/kafka_consumer/README.md
new file mode 100644
index 000000000..15e404215
--- /dev/null
+++ b/plugins/kafka_consumer/README.md
@@ -0,0 +1,24 @@
+# Kafka Consumer
+
+The [Kafka](http://kafka.apache.org/) consumer plugin polls a specified Kafka
+topic and adds messages to InfluxDB. The plugin assumes messages follow the
+line protocol. [Consumer Group](http://godoc.org/github.com/wvanbergen/kafka/consumergroup)
+is used to talk to the Kafka cluster so multiple instances of telegraf can read
+from the same topic in parallel.
+
+## Testing
+
+Running integration tests requires running Zookeeper & Kafka. The following
+commands assume you're on OS X & using [boot2docker](http://boot2docker.io/).
+
+To start Kafka & Zookeeper:
+
+```
+docker run -d -p 2181:2181 -p 9092:9092 --env ADVERTISED_HOST=`boot2docker ip` --env ADVERTISED_PORT=9092 spotify/kafka
+```
+
+To run tests:
+
+```
+ZOOKEEPER_PEERS=$(boot2docker ip):2181 KAFKA_PEERS=$(boot2docker ip):9092 go test
+```