Skip to content

Commit 202cc28

Browse files
author
Achille
authored
remove 0.4 migration docs + other README updates (#849)
1 parent c28bda1 commit 202cc28

File tree

1 file changed

+8
-34
lines changed

1 file changed

+8
-34
lines changed

README.md

Lines changed: 8 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -32,46 +32,20 @@ software.
3232

3333
#### Note:
3434

35-
In order to better align with our newly adopted Code of Conduct, the kafka-go project has renamed our default branch to `main`.
36-
For the full details of our Code Of Conduct see [this](./CODE_OF_CONDUCT.md) document.
37-
38-
## Migrating to 0.4
39-
40-
Version 0.4 introduces a few breaking changes to the repository structure which
41-
should have minimal impact on programs and should only manifest at compile time
42-
(the runtime behavior should remain unchanged).
43-
44-
* Programs do not need to import compression packages anymore in order to read
45-
compressed messages from kafka. All compression codecs are supported by default.
46-
47-
* Programs that used the compression codecs directly must be adapted.
48-
Compression codecs are now exposed in the `compress` sub-package.
49-
50-
* The experimental `kafka.Client` API has been updated and slightly modified:
51-
the `kafka.NewClient` function and `kafka.ClientConfig` type were removed.
52-
Programs now configure the client values directly through exported fields.
53-
54-
* The `kafka.(*Client).ConsumerOffsets` method is now deprecated (along with the
55-
`kafka.TopicAndGroup` type, and will be removed when we release version 1.0.
56-
Programs should use the `kafka.(*Client).OffsetFetch` API instead.
57-
58-
With 0.4, we know that we are starting to introduce a bit more complexity in the
59-
code, but the plan is to eventually converge towards a simpler and more effective
60-
API, allowing us to keep up with Kafka's ever growing feature set, and bringing
61-
a more efficient implementation to programs depending on kafka-go.
62-
63-
We truly appreciate everyone's input and contributions, which have made this
64-
project way more than what it was when we started it, and we're looking forward
65-
to receive more feedback on where we should take it.
35+
In order to better align with our newly adopted Code of Conduct, the kafka-go
36+
project has renamed our default branch to `main`. For the full details of our
37+
Code Of Conduct see [this](./CODE_OF_CONDUCT.md) document.
6638

6739
## Kafka versions
6840

69-
`kafka-go` is currently compatible with Kafka versions from 0.10.1.0 to 2.1.0. While latest versions will be working,
70-
some features available from the Kafka API may not be implemented yet.
41+
`kafka-go` is currently tested with Kafka versions 0.10.1.0 to 2.7.1.
42+
While it should also be compatible with later versions, newer features available
43+
in the Kafka API may not yet be implemented in the client.
7144

7245
## Golang version
7346

74-
`kafka-go` is currently compatible with golang version from 1.15+. To use with older versions of golang use release [v0.2.5](https://github.com/segmentio/kafka-go/releases/tag/v0.2.5).
47+
`kafka-go` is currently compatible with golang version from 1.15+. To use with
48+
older versions of golang use release [v0.2.5](https://github.com/segmentio/kafka-go/releases/tag/v0.2.5).
7549

7650
## Connection [![GoDoc](https://godoc.org/github.com/segmentio/kafka-go?status.svg)](https://godoc.org/github.com/segmentio/kafka-go#Conn)
7751

0 commit comments

Comments
 (0)