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.

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

[SchemaRegistry] Minor readme changes #14990

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 4 additions & 3 deletions sdk/schemaregistry/Azure.Data.SchemaRegistry/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Azure Schema Registry client library for .NET

The Azure Schema Registry service allows developers to provide and retrieve data schemas from a centralized repository for use in messaging systems.
Azure Schema Registry is a schema repository service hosted by Azure Event Hubs, providing schema storage, versioning, and management. The registry is leveraged by serializers to reduce payload size while describing payload structure with schema identifiers rather than full schemas.

## Getting started

Expand Down Expand Up @@ -133,11 +133,11 @@ string schemaContent = schemaProperties.Value.Content;

## Troubleshooting

Information on troubleshooting steps will be added as problems are discovered.
Information on troubleshooting steps will be provided as potential issues are discovered.

## Next steps

Additional information will be available as documents related to Azure Schema Registry are published.
See [Azure Schema Registry][azure_schema_registry] for additional information.

## Contributing

Expand All @@ -164,3 +164,4 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con
[code_of_conduct_faq]: https://opensource.microsoft.com/codeofconduct/faq/
[email_opencode]: mailto:opencode@microsoft.com
[azure_sub]: https://azure.microsoft.com/free/
[azure_schema_registry]: https://aka.ms/schemaregistry
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Azure Schema Registry Apache Avro client library for .NET

This library provides an Apache Avro serialization and deserialization API using the Azure Schema Registry service.
Azure Schema Registry is a schema repository service hosted by Azure Event Hubs, providing schema storage, versioning, and management. This package provides an Avro serializer capable of serializing and deserializing payloads containing Schema Registry schema identifiers and Avro-encoded data.

## Getting started

Expand Down Expand Up @@ -115,11 +115,11 @@ Employee employee = (Employee)serializer.Deserialize(memoryStream, typeof(Employ

## Troubleshooting

Information on troubleshooting steps will be added as problems are discovered.
Information on troubleshooting steps will be provided as potential issues are discovered.

## Next steps

Additional information will be available as documents related to Azure Schema Registry are published.
See [Azure Schema Registry][azure_schema_registry] for additional information.

## Contributing

Expand Down Expand Up @@ -153,3 +153,4 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con
[generic_record]: https://avro.apache.org/docs/current/api/csharp/html/classAvro_1_1Generic_1_1GenericRecord.html
[specific_record]: https://avro.apache.org/docs/current/api/csharp/html/interfaceAvro_1_1Specific_1_1ISpecificRecord.html
[azure_sub]: https://azure.microsoft.com/free/
[azure_schema_registry]: https://aka.ms/schemaregistry