Skip to content

Commit c379b45

Browse files
authored
docs(kafka): update README (#186)
1 parent 6bef99b commit c379b45

File tree

1 file changed

+3
-6
lines changed

1 file changed

+3
-6
lines changed

kafka/README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,9 @@ Package kafka provides a Consumer and a Producer for basic Kafka operations.
55
It relies on https://github.com/confluentinc/confluent-kafka-go which is a Go wrapper on top of https://github.com/edenhill/librdkafka.
66
This provides a reliable implementation, fully supported by the community, but also from Confluent, the creators of Kafka.
77

8+
### Note
9+
`CGO_ENABLED` must NOT be set to 0 since https://github.com/edenhill/librdkafka is a C library.
10+
811
## Docs
912

1013
Please find the generated **godoc** documentation including some examples in [pkg.go.dev](https://pkg.go.dev/mod/github.com/netlify/netlify-commons?tab=packages).
11-
12-
## TODO
13-
14-
- Support standalone consumers and not only consumers members of a consumer group.
15-
- Support seeking by timestamp (only offset is supported)
16-
- Integration tests

0 commit comments

Comments
 (0)