Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
alebabai committed May 9, 2024
1 parent 99d9b2f commit 09e84d7
Showing 1 changed file with 6 additions and 22 deletions.
28 changes: 6 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# go-kit-kafka

> Apache Kafka integration module for go-kit
> Apache Kafka integration module for go-kit powered by [alebabai/go-kafka](https://github.com/alebabai/go-kafka)
[![build](https://img.shields.io/github/actions/workflow/status/alebabai/go-kit-kafka/ci.yml)](https://github.com/alebabai/go-kit-kafka/actions?query=workflow%3ACI)
[![version](https://img.shields.io/github/go-mod/go-version/alebabai/go-kit-kafka)](https://go.dev/)
Expand All @@ -16,37 +16,21 @@ Go modules are supported.
Manual install:

```bash
go get -u github.com/alebabai/go-kit-kafka
go get -u github.com/alebabai/go-kit-kafka/v2
```

Golang import:

```go
import "github.com/alebabai/go-kit-kafka/kafka"
import "github.com/alebabai/go-kit-kafka/v2"
```

## Usage

To use consumer/producer transport abstractions converters to the following types from the chosen Apache Kafka
client library should be implemented:
Just import it into your project and use the provided abstractions to couple your preferred Apache Kafka client library with the well-known [go-kit/kit](https://github.com/go-kit/kit).

```go
type Message struct {
Topic string
Partition int32
Offset int64
Key []byte
Value []byte
Headers []Header
Timestamp time.Time
}

type Header struct {
Key []byte
Value []byte
}
```
For detailed information, please refer to the [alebabai/go-kafka](https://github.com/alebabai/go-kafka) repository.

## Examples

Go to [Examples](examples).
For additional usage details, please check out the [examples](./examples) folder.

0 comments on commit 09e84d7

Please sign in to comment.