|
|
@@ -2,22 +2,31 @@
|
|
|
layout: index
|
|
|
---
|
|
|
|
|
|
-Documentation is available via
|
|
|
-[godoc](https://godoc.org/github.com/Shopify/sarama).
|
|
|
+Sarama is an MIT-licensed Go client library for [Apache Kafka](https://kafka.apache.org/) version 0.8 (and later).
|
|
|
+
|
|
|
+API documentation and examples are available via [godoc](https://godoc.org/github.com/Shopify/sarama).
|
|
|
+
|
|
|
+## 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.
|
|
|
+the two latest stable releases of Kafka and Go, and we provide a two month
|
|
|
+grace period for older releases. This means we currently officially support
|
|
|
+Go 1.4 and 1.5, and Kafka 0.8.1 and 0.8.2, although older releases are still
|
|
|
+likely to work.
|
|
|
|
|
|
-Sarama follows semantic versioning and provides API stability via the gopkg.in
|
|
|
-service. You can import a version with a guaranteed stable API via [`import
|
|
|
-"gopkg.in/Shopify/sarama.v1"`](http://gopkg.in/Shopify/sarama.v1).
|
|
|
+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](https://github.com/Shopify/sarama/blob/master/CHANGELOG.md).
|
|
|
|
|
|
-Other related links:
|
|
|
+## Contributing
|
|
|
|
|
|
-* [Kafka Project Home](https://kafka.apache.org)
|
|
|
-* [Kafka Protocol Specification](https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol)
|
|
|
+* Get started by checking our [contribution guidelines](https://github.com/Shopify/sarama/blob/master/CONTRIBUTING.md).
|
|
|
+* Read the [Sarama wiki](https://github.com/Shopify/sarama/wiki) for more
|
|
|
+ technical and design details.
|
|
|
+* The [Kafka Protocol Specification](https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol)
|
|
|
+ contains a wealth of useful information.
|
|
|
+* For more general issues, there is [a google group](https://groups.google.com/forum/#!forum/kafka-clients) for Kafka client developers.
|
|
|
+* If you have any questions, just ask!
|
|
|
|
|
|
## License
|
|
|
|
Evan Huus