Skip to content
This repository has been archived by the owner on Jun 30, 2023. It is now read-only.

Commit

Permalink
Add Compatibility and Contributions to README (#33)
Browse files Browse the repository at this point in the history
  • Loading branch information
mike9005 authored Dec 30, 2019
1 parent d7ab0dd commit 2fba9ee
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
# kafka-connect-protobuf-converter
Converter plugin for [Kafka Connect](https://docs.confluent.io/3.2.0/connect/). A converter
Converter plugin for [Kafka Connect](https://docs.confluent.io/current/connect/). A converter
controls the format of the data that will be written to Kafka for source connectors or
read from Kafka for sink connectors.

## Compatibility

The 2.x release series is compatible with Kafka Connect 5.x. and up (older releases have been validated to work all the way back to Kafka Connect 3.2.0, although we highly recommend updating to the latest version).

*N.B. This converter only works with `proto3` protocol buffer schemas.*

## Usage
Copy the `kafka-connect-protobuf-converter` jar and the jar containing your protocol buffers to

Copy the `kafka-connect-protobuf-converter` jar and the jar containing your compiled protocol buffers to
`/usr/share/java/kafka-serde-tools` on your Kafka Connect instance and restart Kafka Connect.

Converters can be specified on a per-connector basis.
Expand Down Expand Up @@ -143,7 +150,12 @@ message TestMessage {
}
```

## Contributing

Contributions are warmly welcomed. If fixing a bug, please open an issue on the project before opening a PR. This helps with documentation for other users and will make code review go quicker 🙌

## Development

#### Run tests:
```
mvn test
Expand Down

0 comments on commit 2fba9ee

Please sign in to comment.