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

fixed note on how to install opentelemetry-api and opentelemetry-sdk #288

Merged
merged 1 commit into from
Jun 30, 2020
Merged
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
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,22 @@ depend on `opentelemetry-sdk` or another package that implements the API.
**Please note** that this library is currently in _alpha_, and shouldn't be
used in production environments.

The API and SDK packages are available on RubyGems.org, and can be installed via `bundle`:
The API and SDK packages are available on RubyGems.org, and can be installed via `gem`:

```sh
bundle install opentelemetry-api
bundle install opentelemetry-sdk
gem install opentelemetry-api
gem install opentelemetry-sdk
```

or via `Bundler` by adding the following to your `Gemfile`:

```ruby
gem 'opentelemetry-api'
gem 'opentelemetry-sdk'
```
followed by:
```sh
bundle install
```

To install development versions of these packages, follow the "Developer Setup" section (below).
Expand Down