-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #149 from Shopify/update-readme
README tweaks
- Loading branch information
Showing
1 changed file
with
5 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
||
There is a google group for discussion | ||
* web: https://groups.google.com/forum/#!forum/sarama-users | ||
* email: [email protected] | ||
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). | ||
|
||
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 | ||
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 | ||
* [Kafka Project Home](https://kafka.apache.org/) | ||
* [Kafka Protocol Specification](https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol) |