Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add PSA to README #257

Closed
wants to merge 1 commit into from
Closed

Add PSA to README #257

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

`@kafkajs/confluent-schema-registry` is a library that makes it easier to interact with the Confluent schema registry, it provides convenient methods to encode, decode and register new schemas using the Apache Avro serialization format and Confluent's [wire format](https://docs.confluent.io/current/schema-registry/docs/serializer-formatter.html#wire-format).

Note that this is an unofficial client that is maintained based on the [specific needs of the primary maintainer, as well as the contributions of the community](https://github.com/kafkajs/confluent-schema-registry/issues/215#issuecomment-1261967603). For example, at the time of this writing, this package is **NOT** fully compliant with Confluent's [Protobuf serialization spec](https://docs.confluent.io/platform/current/schema-registry/fundamentals/serdes-develop/index.html#wire-format). This means that this package will only work when it used as *both* the serializer *and* deserializer of schema registry messages. So, for example, if you're serializing Protobuf messages with [Confluent's Kafka Golang client](https://github.com/confluentinc/confluent-kafka-go), this package will not correctly deserialize those messages (and vice-versa). See https://github.com/kafkajs/confluent-schema-registry/issues/152 for more detail on this.

[![Build Status](https://dev.azure.com/tulios/ConfluentSchemaRegistry/_apis/build/status/kafkajs.confluent-schema-registry?branchName=master)](https://dev.azure.com/tulios/ConfluentSchemaRegistry/_build/latest?definitionId=3&branchName=master)

## Getting started
Expand Down