Browse Source

Merge pull request #149 from Shopify/update-readme

README tweaks
Willem van Bergen 11 years ago
parent
commit
f503eb0f7b
1 changed files with 5 additions and 7 deletions
  1. 5 7
      README.md

+ 5 - 7
README.md

@@ -8,18 +8,16 @@ 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
 
 
-There is a google group for discussion
-* web: https://groups.google.com/forum/#!forum/sarama-users
-* email: sarama-users@googlegroups.com
+There is a google group for Kafka client users and authors at https://groups.google.com/forum/#!forum/kafka-clients
 
 
-It is compatible with Go 1.1, 1.2, and 1.3 (which means `go vet` on 1.2 or 1.3 may return
+Sarama is compatible with Go 1.1, 1.2, and 1.3 (which means `go vet` on 1.2 or 1.3 may return
 some suggestions that we are ignoring for the sake of compatibility with 1.1).
 some suggestions that we are ignoring for the sake of compatibility with 1.1).
 
 
-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. 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.
 It is absolutely stable enough to use, just expect that you might have to tweak things when you update to a newer version.
 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:
 Other related links:
-* https://kafka.apache.org/
-* https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol
+* [Kafka Project Home](https://kafka.apache.org/)
+* [Kafka Protocol Specification](https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol)