Przeglądaj źródła

Update README.md

Add note about API stability (since Go packages are otherwise assumed to have a semantically stable API).
Evan Huus 12 lat temu
rodzic
commit
3ae0bd28de
1 zmienionych plików z 5 dodań i 0 usunięć
  1. 5 0
      README.md

+ 5 - 0
README.md

@@ -5,6 +5,11 @@ 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
 
+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.
+
 Other related links:
 * https://kafka.apache.org/
 * https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol