From b6cc5b0952e42c473e0c2bf6b4ccb86f490e5877 Mon Sep 17 00:00:00 2001 From: Willem van Bergen Date: Wed, 18 Mar 2015 10:51:09 -0400 Subject: [PATCH] README tweaks --- README.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 4c081eb49..a0aaae329 100644 --- a/README.md +++ b/README.md @@ -6,20 +6,25 @@ sarama Sarama is an MIT-licensed Go client library for Apache Kafka 0.8 (and later). -Documentation is available via godoc at https://godoc.org/github.com/Shopify/sarama. -Mocks for testing are available in the [mocks](mocks) subpackage. +### Getting started -There is a google group for Kafka client users and authors at https://groups.google.com/forum/#!forum/kafka-clients +- 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. +- The [examples](./examples) directory contains more elaborate example applications. +- There is a google group for Kafka client users and authors at https://groups.google.com/forum/#!forum/kafka-clients + +### Compatibility and API stability Sarama provides a "2 releases + 2 months" compatibility guarantee: we support the two latest releases of Kafka and Go, and we provide a two month grace period for older releases. This means we currently officially support Go 1.3 and 1.4, and Kafka 0.8.1 and 0.8.2. -Sarama follows semantic versioning and provides API stability via the gopkg.in -service. You can import a version with a guaranteed stable API via -http://gopkg.in/Shopify/sarama.v1. A changelog is available -[here](CHANGELOG.md). +Sarama follows semantic versioning and provides API stability via the gopkg.in service. +You can import a version with a guaranteed stable API via http://gopkg.in/Shopify/sarama.v1. +A changelog is available [here](CHANGELOG.md). + +### Other -Other related links: +* [Sarama wiki](https://github.com/Shopify/sarama/wiki) to get started hacking on sarama itself. * [Kafka Project Home](https://kafka.apache.org/) * [Kafka Protocol Specification](https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol)