Skip to content

Commit 20abcb7

Browse files
Updates to README.md for Protobuf and JSON serdes (#1267)
* remove charset=uft8 from content-type header (#1247) thanks! * Added test for Consumer.Assign with Offset.Beginning/Offset.End (#1256) * Added test for Consumer.Assign with Offset.Beginning/Offset.End * Addressed review feedback * Updated readme for Protobuf + JSON * Fixes following review feedback Co-authored-by: Zhongming Chen <[email protected]>
1 parent b15c32e commit 20abcb7

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ client. Thanks Andreas!
3333

3434
## Referencing
3535

36-
confluent-kafka-dotnet is distributed via NuGet. We provide three packages:
36+
confluent-kafka-dotnet is distributed via NuGet. We provide five packages:
3737

3838
- [Confluent.Kafka](https://www.nuget.org/packages/Confluent.Kafka/) *[net45, netstandard1.3, netstandard2.0]* - The core client library.
3939
- [Confluent.SchemaRegistry.Serdes.Avro](https://www.nuget.org/packages/Confluent.SchemaRegistry.Serdes.Avro/) *[netstandard2.0]* - Provides a serializer and deserializer for working with Avro serialized data with Confluent Schema Registry integration.
@@ -200,11 +200,14 @@ class Program
200200
}
201201
```
202202

203-
### Working with Apache Avro
203+
### Schema Registry Integration
204204

205-
The `Confluent.SchemaRegistry.Serdes` nuget package provides an Avro serializer and deserializer that integrate with [Confluent
206-
Schema Registry](https://docs.confluent.io/current/schema-registry/docs/index.html). The `Confluent.SchemaRegistry`
207-
nuget package provides a client for interfacing with Schema Registry's REST API.
205+
The three "Serdes" packages provide serializers and deserializers for Avro, Protobuf and JSON with [Confluent Schema Registry](https://docs.confluent.io/current/schema-registry/docs/index.html) integration. The `Confluent.SchemaRegistry` nuget package provides a client for interfacing with
206+
Schema Registry's REST API.
207+
208+
**Note:** All three serialization formats are supported across Confluent Platform. They each make different tradeoffs, and you should use the one that best matches to your requirements. Avro is well suited to the streaming data use-case, but the maturity of the non-Java implementations lags that of Java - this is an important consideration. Protobuf and JSON both have great support in .NET.
209+
210+
#### Avro
208211

209212
You can use the Avro serializer and deserializer with the `GenericRecord` class or with specific classes generated
210213
using the `avrogen` tool, available via Nuget (.NET Core 2.1 required):

0 commit comments

Comments
 (0)