|
|
@@ -2,9 +2,17 @@
|
|
|
layout: index
|
|
|
---
|
|
|
|
|
|
-Sarama is compatible with Go 1.2, 1.3, and 1.4.
|
|
|
+Documentation is available via godoc at
|
|
|
+https://godoc.org/github.com/Shopify/sarama.
|
|
|
|
|
|
-A word of warning: the API is not 100% stable yet. It won't change much (in particular the low-level Broker and Request/Response objects could *probably* be considered frozen) but there may be the occasional parameter added or function renamed. As far as semantic versioning is concerned, we haven't quite hit 1.0.0 yet. It is absolutely stable enough to use, just expect that you might have to tweak things when you update to a newer version.
|
|
|
+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.
|
|
|
|
|
|
Other related links:
|
|
|
|
|
|
@@ -13,4 +21,4 @@ Other related links:
|
|
|
|
|
|
## License
|
|
|
|
|
|
-Copyright (c) 2014 Shopify. Released under the [MIT-LICENSE](http://opensource.org/licenses/MIT).
|
|
|
+Copyright (c) 2015 Shopify. Released under the [MIT-LICENSE](http://opensource.org/licenses/MIT).
|
Evan Huus