Skip to content
This repository was archived by the owner on Jul 11, 2025. It is now read-only.

Commit edfb557

Browse files
committed
Initial readme update
1 parent aa86152 commit edfb557

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,21 @@ Swift Distributed Tracing Extras ships the following extra modules:
88

99
### OpenTelemetry Semantic Conventions
1010

11+
#### Getting Started
12+
13+
This module is complementary to [swift-distributed-tracing](https://github.com/apple/swift-distributed-tracing) so you will want to depend on it (the API package).
14+
15+
16+
Then, you can depend on the extras package:
17+
18+
```swift
19+
.package(url: "https://github.com/apple/swift-distributed-tracing.git", from: "..."),
20+
.package(url: "https://github.com/apple/swift-distributed-tracing-extras.git", from: "..."),
21+
```
22+
23+
> If you are writing an application, rather than a library, you'll also want to depend on a specific tracer implementation. For available implementations refer to the [swift-distributed-tracing README.md](https://github.com/apple/swift-distributed-tracing).
24+
25+
#### Usage
26+
1127
The OpenTelemetry Semantic Conventions package provides span attributes to work with [OpenTelemetry's
1228
semantic conventions](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions).

0 commit comments

Comments
 (0)