Browse Source

Mention 1.0 compat and vet issues in README

Evan Huus 12 years ago
parent
commit
cd81a9cf7f
1 changed files with 3 additions and 0 deletions
  1. 3 0
      README.md

+ 3 - 0
README.md

@@ -5,6 +5,9 @@ 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 http://godoc.org/github.com/Shopify/sarama
 
 
+It is compatible with Go 1.0 and 1.1 (which means `go vet` on Go 1.1 will return
+some suggestions that we are ignoring for the sake of compatibility with 1.0).
+
 A word of warning: the API is not 100% stable yet. It won't change much (in particular the low-level
 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
 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.
 parameter added or function renamed. As far as semantic versioning is concerned, we haven't quite hit 1.0.0 yet.