README.md in opentelemetry-sdk-1.5.0 vs README.md in opentelemetry-sdk-1.6.0

- old
+ new

@@ -10,17 +10,23 @@ ## How does this gem fit in? The `opentelemetry-sdk` gem provides the reference implementation of the OpenTelemetry Ruby interfaces defined in the `opentelemetry-api` gem. That is, it includes the *functionality* needed to collect, analyze, and export telemetry data produced using the API. -Generally, Ruby *applications* should install `opentelemetry-sdk` (or other concrete implementation of the OpenTelemetry API). Using the SDK, an application can configure how it wants telemetry data to be handled, including which data should be persisted, how it should be formatted, and where it should be recorded or exported. However, *libraries* that produce telemetry data should generally depend only on `opentelemetry-api`, deferring the choise of concrete implementation to the application developer. +Generally, Ruby *applications* should install `opentelemetry-sdk` (or +other concrete implementation of the OpenTelemetry API). Using the SDK, +an application can configure how it wants telemetry data to be handled, +including which data should be persisted, how it should be formatted, +and where it should be recorded or exported. However, *libraries* that +produce telemetry data should generally depend only on +`opentelemetry-api`, deferring the choice of concrete implementation to the application developer. ## How do I get started? Install the gem using: -``` +```sh gem install opentelemetry-sdk ``` Or, if you use [bundler][bundler-home], include `opentelemetry-sdk` in your `Gemfile`. @@ -51,11 +57,11 @@ # ) # # c.use 'OpenTelemetry::Instrumentation::Net::HTTP' # end # -# Note that the SimpleSpanExporter is not recommended for use in production. +# Note that the SimpleSpanProcessor is not recommended for use in production. # To start a trace you need to get a Tracer from the TracerProvider tracer = OpenTelemetry.tracer_provider.tracer('my_app_or_gem', '0.1.0') @@ -82,10 +88,9 @@ The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig]. ## License The `opentelemetry-sdk` gem is distributed under the Apache 2.0 license. See [LICENSE][license-github] for more information. - [opentelemetry-home]: https://opentelemetry.io [bundler-home]: https://bundler.io [repo-github]: https://github.com/open-telemetry/opentelemetry-ruby [license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/main/LICENSE