Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jack-berg committed Dec 12, 2023
1 parent d59d4a6 commit f966459
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,18 @@ Published releases are available on maven central. Replace `{{version}}` with th
```xml
<project>
<dependencies>
<!-- Stable semantic conventions. Note: generated code is still subject to breaking changes while published with "-alpha" suffix. -->
<dependency>
<groupId>io.opentelemetry.semconv</groupId>
<artifactId>opentelemetry-semconv</artifactId>
<version>{{version}}</version>
</dependency>
<!-- Incubating semantic conventions. Breaking changes expected. Library instrumentation SHOULD NOT depend on this. -->
<dependency>
<groupId>io.opentelemetry.semconv</groupId>
<artifactId>opentelemetry-semconv.incubating</artifactId>
<version>{{version}}</version>
</dependency>
</dependencies>
</project>
```
Expand All @@ -28,7 +35,10 @@ Published releases are available on maven central. Replace `{{version}}` with th

```groovy
dependencies {
// Stable semantic conventions. Note: generated code is still subject to breaking changes while published with "-alpha" suffix.
implementation platform("io.opentelemetry.semconv:opentelemetry-semconv:{{version}}")
// Incubating semantic conventions. Breaking changes expected. Library instrumentation SHOULD NOT depend on this.
implementation platform("io.opentelemetry.semconv:opentelemetry-semconv-incubating:{{version}}")
}
```

Expand All @@ -37,7 +47,7 @@ dependencies {
Java 17 or higher is required to build the projects in this repository. The built artifacts can be
used on Java 8 or higher.

To use this artifact you must also depend on `io.opentelemetry:opentelemetry-api:{{version}}`.
To use these artifacts, you must also depend on `io.opentelemetry:opentelemetry-api:{{version}}`.
See [opentelemetry-java releases](https://github.com/open-telemetry/opentelemetry-java#releases) for
more information.

Expand All @@ -57,6 +67,8 @@ of [open-telemetry/semantic-conventions](https://github.com/open-telemetry/seman
defined in the `semanticConventionsVersion` variable of [build.gradle.kts](./build.gradle.kts) and
generate semantic conventions classes from the release contents.

TODO: Update the following paragraph with new strategy for managing compatibility

This repository publishes `-alpha` artifacts and as discussed
in [opentelemetry-java/VERSIONING.md](https://github.com/open-telemetry/opentelemetry-java/blob/main/VERSIONING.md),
we make no compatibility guarantees. However, by convention we've been keeping attribute constants
Expand Down

0 comments on commit f966459

Please sign in to comment.