From 1ac64c82ab2fe581cf1c716e6aec4f3541372db2 Mon Sep 17 00:00:00 2001 From: Bryce Buchanan Date: Tue, 29 Oct 2024 14:19:31 -0700 Subject: [PATCH] added notes about cocoapods to README.md --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 63fdb01f..1cfb12e4 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,25 @@ or .target(name: "ExampleApp", dependencies: ["OpenTelemetrySdk"]), ``` +### Cocoapods + +As of version 1.11.0, OpenTelemetry-Swift support cocoapods. +Two pods are provided: + +- `OpenTelemetry-Swift-Api` + +- `OpenTelemetry-Swift-Sdk` + +`OpenTelemetry-Swift-Api` is a dependency of `OpenTelemetry-Swift-Sdk`. + +Most users will want to add the following to their pod file: + +`pod 'OpenTelemetry-Swift-Sdk'` + +This will add both the API and SDK. If you're only interesting in Adding the API add the following: + +`pod 'OpenTelemetry-Swift-Api'` + ## Documentation Official documentation for the library can be found in the official opentelemetry [documentation page](https://opentelemetry.io/docs/instrumentation/swift/), including: