Skip to content

Commit

Permalink
add note to readme.md that right now this gem is part of ddtrace and …
Browse files Browse the repository at this point in the history
…not to be used on its own
  • Loading branch information
anmarchenko committed Sep 7, 2023
1 parent 25d26b2 commit ad66883
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
# Datadog CI Visibility for Ruby

Datadog's Ruby Library for instrumenting your test and continuous integration pipeline. Checkout to learn more at our [official website](https://docs.datadoghq.com/continuous_integration/tests/ruby/?tab=azurepipelines).
Datadog's Ruby Library for instrumenting your test and continuous integration pipeline.
Learn more on our [official website](https://docs.datadoghq.com/continuous_integration/tests/ruby/?tab=azurepipelines).

NOTE: currently this gem is a runtime dependency for the `ddtrace` gem and is not supposed to be used standalone. This will
change when ddtrace v2.0 and datadog-ci v1.0 are released.

## Installation

Add to your Gemfile.

```ruby
group :test do
gem "datadog-ci"
end
gem "ddtrace"
```

## Usage
Expand Down

0 comments on commit ad66883

Please sign in to comment.