From 0860630a2efb0b118c716a86122af18d4b70e41f Mon Sep 17 00:00:00 2001 From: Joey Baruch Date: Tue, 29 Aug 2017 16:38:24 +0300 Subject: [PATCH] Add README.md to Kafka io --- sdks/java/io/kafka/README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 sdks/java/io/kafka/README.md diff --git a/sdks/java/io/kafka/README.md b/sdks/java/io/kafka/README.md new file mode 100644 index 000000000000..15851c51fe76 --- /dev/null +++ b/sdks/java/io/kafka/README.md @@ -0,0 +1,36 @@ + + +KafkaIO is a beam connector to [Apache Kafka](http://kafka.apache.org/)'s messaging framework. It enables using kafka as an unbounded source or sink in your pipeline. + +## Dependencies + +To use KafkaIO you must first add a dependency on `beam-sdks-java-io-kafka` + +```maven + + org.apache.beam + beam-sdks-java-io-kafka + ... + +``` + +## Documentation + +- [KafkaIO class](https://github.com/apache/beam/blob/master/sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/KafkaIO.java)