From 79ecce82bb29d2a71a66f8fd79c8d33c26b17ce9 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Wed, 8 Mar 2023 05:44:24 -0500 Subject: [PATCH] Update README.md --- opentracing-shim/README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/opentracing-shim/README.md b/opentracing-shim/README.md index 826ce483d6..5a4fc77408 100644 --- a/opentracing-shim/README.md +++ b/opentracing-shim/README.md @@ -1,10 +1,10 @@ -# OpenTracing Shim +# C++ OpenTracing Shim [![Apache License][license-image]][license-image] -The OpenTracing shim is a bridge layer from OpenTelemetry to the OpenTracing API. -It takes an OpenTelemetry Tracer and exposes it as an implementation compatible with -that of an OpenTracing Tracer. +An [OpenTracing shim][migrating] is a bridge layer from OpenTelemetry to the +OpenTracing API. It takes an OpenTelemetry Tracer and exposes it as an +implementation compatible with that of an OpenTracing Tracer. ## Usage @@ -37,15 +37,17 @@ auto tracer_shim = TracerShim::createTracerShim(tracer, propagators); If propagators are not specified, OpenTelemetry's global propagator will be used. -## License +## More information and help -Apache 2.0 - See [LICENSE][license-url] for more information. +- [Migrating from OpenTracing][migrating] +- [OpenTelemetry](https://opentelemetry.io) +- For help or feedback on this project, join us in [GitHub Discussions][discussions-url] -## Useful links +## License -- For more information on OpenTelemetry, visit: -- For help or feedback on this project, join us in [GitHub Discussions][discussions-url] +Apache 2.0 - See [LICENSE][license-url] for more information. [discussions-url]: https://github.com/open-telemetry/opentelemetry-cpp/discussions [license-url]: https://github.com/open-telemetry/opentelemetry-cpp/blob/main/LICENSE [license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat +[migrating]: https://opentelemetry.io/docs/migration/opentracing/