|
@@ -1,5 +1,4 @@
|
|
|
-sarama
|
|
|
-======
|
|
|
+# sarama
|
|
|
|
|
|
[](https://godoc.org/github.com/Shopify/sarama)
|
|
|
[](https://travis-ci.org/Shopify/sarama)
|
|
@@ -7,7 +6,7 @@ sarama
|
|
|
|
|
|
Sarama is an MIT-licensed Go client library for [Apache Kafka](https://kafka.apache.org/) version 0.8 (and later).
|
|
|
|
|
|
-### Getting started
|
|
|
+## Getting started
|
|
|
|
|
|
- API documentation and examples are available via [godoc](https://godoc.org/github.com/Shopify/sarama).
|
|
|
- Mocks for testing are available in the [mocks](./mocks) subpackage.
|
|
@@ -16,24 +15,22 @@ Sarama is an MIT-licensed Go client library for [Apache Kafka](https://kafka.apa
|
|
|
|
|
|
You might also want to look at the [Frequently Asked Questions](https://github.com/Shopify/sarama/wiki/Frequently-Asked-Questions).
|
|
|
|
|
|
-### Compatibility and API stability
|
|
|
+## Compatibility and API stability
|
|
|
|
|
|
Sarama provides a "2 releases + 2 months" compatibility guarantee: we support
|
|
|
the two latest stable releases of Kafka and Go, and we provide a two month
|
|
|
grace period for older releases. This means we currently officially support
|
|
|
-Go 1.11 through 1.12, and Kafka 2.0 through 2.3, although older releases are
|
|
|
+Go 1.11 through 1.13, and Kafka 2.1 through 2.3, although older releases are
|
|
|
still likely to work.
|
|
|
|
|
|
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).
|
|
|
|
|
|
-### Contributing
|
|
|
+## Contributing
|
|
|
|
|
|
-* Get started by checking our [contribution guidelines](https://github.com/Shopify/sarama/blob/master/.github/CONTRIBUTING.md).
|
|
|
-* Read the [Sarama wiki](https://github.com/Shopify/sarama/wiki) for more
|
|
|
- technical and design details.
|
|
|
-* The [Kafka Protocol Specification](https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol)
|
|
|
- contains a wealth of useful information.
|
|
|
-* For more general issues, there is [a google group](https://groups.google.com/forum/#!forum/kafka-clients) for Kafka client developers.
|
|
|
-* If you have any questions, just ask!
|
|
|
+- Get started by checking our [contribution guidelines](https://github.com/Shopify/sarama/blob/master/.github/CONTRIBUTING.md).
|
|
|
+- Read the [Sarama wiki](https://github.com/Shopify/sarama/wiki) for more technical and design details.
|
|
|
+- The [Kafka Protocol Specification](https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol) contains a wealth of useful information.
|
|
|
+- For more general issues, there is [a google group](https://groups.google.com/forum/#!forum/kafka-clients) for Kafka client developers.
|
|
|
+- If you have any questions, just ask!
|