README.md in opentelemetry-metrics-api-0.1.0 vs README.md in opentelemetry-metrics-api-0.1.1
- old
+ new
@@ -10,18 +10,22 @@
## How does this gem fit in?
The `opentelemetry-metrics-api` gem defines the core OpenTelemetry interfaces in the form of abstract classes and no-op implementations. That is, it defines interfaces and data types sufficient for a library or application to code against to produce telemetry data, but does not actually collect, analyze, or export the data.
-To collect and analyze telemetry data, _applications_ should also install a concrete implementation of the API, such as the `opentelemetry-metrics-sdk` gem. However, _libraries_ that produce telemetry data should depend only on `opentelemetry-metrics-api`, deferring the choise of concrete implementation to the application developer.
+To collect and analyze telemetry data, _applications_ should also
+install a concrete implementation of the API, such as the
+`opentelemetry-metrics-sdk` gem. However, _libraries_ that produce
+telemetry data should depend only on `opentelemetry-metrics-api`,
+deferring the choice of concrete implementation to the application developer.
This code is still under development and is not a complete implementation of the Metrics API. Until the code becomes stable, Metrics API functionality will live outside the `opentelemetry-api` library.
## How do I get started?
Install the gem using:
-```
+```sh
gem install opentelemetry-metrics-api
```
Or, if you use [bundler][bundler-home], include `opentelemetry-metrics-api` in your `Gemfile`.