diff --git a/README.md b/README.md index bfa2cbb..ba6a784 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ -# Couchbase Connector +# Kafka Connect Couchbase Connector -The Couchbase connector allows you to import data from Couchbase Server into Kafka topics. +kafka-connect-couchbase is a [Kafka Connector](http://kafka.apache.org/documentation.html#connect) +for loading data from Couchbase Server database into Kafka. ## Quickstart Start by setting up Couchbase Server, and loading sample bucket called `travel-sample`. -Build the connector jar: +To build a development version you'll need a recent version of Kafka. You can build +kafka-connect-couchbase with Maven using the standard lifecycle phases. Build the connector jar: $ mvn package @@ -51,3 +53,12 @@ To observe replicated events from the cluster, run CLI kafka consumer: $ kafka-avro-console-consumer --new-consumer --bootstrap-server localhost:9092 \ --topic test-couchbase --from-beginning + +# Contribute + +- Source Code: https://github.com/couchbaselabs/kafka-connect-couchbase +- Issue Tracker: https://issues.couchbase.com/projects/KAFKAC + +# License + +The project is licensed under the Apache 2 license. \ No newline at end of file diff --git a/pom.xml b/pom.xml index a2d181a..79a14c3 100644 --- a/pom.xml +++ b/pom.xml @@ -23,7 +23,7 @@ com.couchbase.client kafka-connect-couchbase jar - 1.0.0 + 3.0.0-DP1 kafka-connect-couchbase Couchbase, Inc.