浏览代码

Update README for semantic versioning and gopkg.in

Evan Huus 10 年之前
父节点
当前提交
a3b46b96d8
共有 1 个文件被更改,包括 5 次插入5 次删除
  1. 5 5
      README.md

+ 5 - 5
README.md

@@ -6,7 +6,7 @@ sarama
 
 Sarama is an MIT-licensed Go client library for Apache Kafka 0.8 (and later).
 
-Documentation is available via godoc at http://godoc.org/github.com/Shopify/sarama
+Documentation is available via godoc at https://godoc.org/github.com/Shopify/sarama
 
 There is a google group for Kafka client users and authors at https://groups.google.com/forum/#!forum/kafka-clients
 
@@ -14,10 +14,10 @@ Sarama provides a "2 releases + 2 months" compatibility guarantee: we support th
 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.
 
-A word of warning: the API is not 100% stable. 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 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 related links:
 * [Kafka Project Home](https://kafka.apache.org/)