diff --git a/Code/Comscore/README.md b/Code/Comscore/README.md index 4e99d12e..7d1e8f99 100644 --- a/Code/Comscore/README.md +++ b/Code/Comscore/README.md @@ -4,12 +4,21 @@ THEOplayer-Connector-Comscore provides an integration between the THEOplayerSDK ## Installation -### [Cocoapods](https://guides.cocoapods.org/using/getting-started.html#getting-started) +### [CocoaPods](https://guides.cocoapods.org/using/getting-started.html#getting-started) 1. Create a Podfile if you don't already have one. From the root of your project directory, run the following command: `pod init` -2. To your Podfile, add the OptiView Player specs source first: `source 'https://github.com/THEOplayer/cocoapods-specs.git'`, followed by the public source for third-party dependencies: `source 'https://cdn.cocoapods.org/'`. -3. To your Podfile, add the connector pods that you want to use in your app: `pod 'THEOplayer-Connector-Comscore'` -4. Install the pods using `pod install` , then open your `.xcworkspace` file to see the project in Xcode. +2. Add the sources and connector pod to your Podfile, including [our CocoaPods spec repo](https://optiview.dolby.com/docs/theoplayer/getting-started/sdks/ios/cocoapods-spec-repo/): + + ```ruby + source 'https://github.com/THEOplayer/cocoapods-specs' + source 'https://cdn.cocoapods.org/' + + target 'MyApp' do + pod 'THEOplayer-Connector-Comscore' + end + ``` + +3. Install the pods using `pod install`, then open your `.xcworkspace` file to see the project in Xcode. To support custom feature builds of THEOplayerSDK perform the following steps: diff --git a/Code/Conviva/README.md b/Code/Conviva/README.md index 77029ef7..8429cc67 100644 --- a/Code/Conviva/README.md +++ b/Code/Conviva/README.md @@ -22,13 +22,22 @@ To support custom feature builds of THEOplayerSDK perform the following steps: 1. Choose `File` > `Packages` > `Reset Package Caches` from the menu bar. 2. If it is still not working, make sure to remove any `THEOplayerSDK.xcframework` inclusions that you manually installed before installing this THEOplayer-Connector-Conviva package. -### [Cocoapods](https://guides.cocoapods.org/using/getting-started.html#getting-started) +### [CocoaPods](https://guides.cocoapods.org/using/getting-started.html#getting-started) 1. Create a Podfile if you don't already have one. From the root of your project directory, run the following command: `pod init` -2. To your Podfile, add the OptiView Player specs source first: `source 'https://github.com/THEOplayer/cocoapods-specs.git'`, followed by the public source for third-party dependencies: `source 'https://cdn.cocoapods.org/'`. -3. To your Podfile, add the Conviva connector pods that you want to use in your app: `pod 'THEOplayer-Connector-Conviva'` +2. Add the sources and connector pod to your Podfile, including [our CocoaPods spec repo](https://optiview.dolby.com/docs/theoplayer/getting-started/sdks/ios/cocoapods-spec-repo/): + + ```ruby + source 'https://github.com/THEOplayer/cocoapods-specs' + source 'https://cdn.cocoapods.org/' + + target 'MyApp' do + pod 'THEOplayer-Connector-Conviva' + end + ``` + - When using THEOads, also add the THEOads subspec so that failed THEOads ad breaks (e.g. an empty VAST response) are reported to Conviva: `pod 'THEOplayer-Connector-Conviva/THEOads'` -4. Install the pods using `pod install` , then open your `.xcworkspace` file to see the project in Xcode. +3. Install the pods using `pod install`, then open your `.xcworkspace` file to see the project in Xcode. To support custom feature builds of THEOplayerSDK perform the following steps: diff --git a/Code/Nielsen/README.md b/Code/Nielsen/README.md index 5bdc55cd..338f2003 100644 --- a/Code/Nielsen/README.md +++ b/Code/Nielsen/README.md @@ -20,12 +20,22 @@ To support custom feature builds of THEOplayerSDK perform the following steps: 1. Choose `File` > `Packages` > `Reset Package Caches` from the menu bar. 2. If it is still not working, make sure to remove any `THEOplayerSDK.xcframework` inclusions that you manually installed before installing this connector package. -### [Cocoapods](https://guides.cocoapods.org/using/getting-started.html#getting-started) +### [CocoaPods](https://guides.cocoapods.org/using/getting-started.html#getting-started) 1. Create a Podfile if you don't already have one. From the root of your project directory, run the following command: `pod init` -2. To your Podfile, add the OptiView Player specs source first: `source 'https://github.com/THEOplayer/cocoapods-specs.git'`, followed by the public and Nielsen sources: `source 'https://cdn.cocoapods.org/'` and `source 'https://github.com/NielsenDigitalSDK/nielsenappsdk-ios-specs-dynamic.git'`. -3. To your Podfile, add the connector pods that you want to use in your app: `pod 'THEOplayer-Connector-Nielsen'` -4. Install the pods using `pod install` , then open your `.xcworkspace` file to see the project in Xcode. +2. Add the sources and connector pod to your Podfile, including [our CocoaPods spec repo](https://optiview.dolby.com/docs/theoplayer/getting-started/sdks/ios/cocoapods-spec-repo/): + + ```ruby + source 'https://github.com/THEOplayer/cocoapods-specs' + source 'https://cdn.cocoapods.org/' + source 'https://github.com/NielsenDigitalSDK/nielsenappsdk-ios-specs-dynamic.git' + + target 'MyApp' do + pod 'THEOplayer-Connector-Nielsen' + end + ``` + +3. Install the pods using `pod install`, then open your `.xcworkspace` file to see the project in Xcode. To support custom feature builds of THEOplayerSDK perform the following steps: diff --git a/Code/Sideloaded-TextTracks/README.md b/Code/Sideloaded-TextTracks/README.md index be940b46..bb2582cb 100644 --- a/Code/Sideloaded-TextTracks/README.md +++ b/Code/Sideloaded-TextTracks/README.md @@ -10,12 +10,21 @@ This connector is intended to be used for subtitle text tracks specific with the ## Installation -### [Cocoapods](https://guides.cocoapods.org/using/getting-started.html#getting-started) +### [CocoaPods](https://guides.cocoapods.org/using/getting-started.html#getting-started) 1. Create a Podfile if you don't already have one. From the root of your project directory, run the following command: `pod init` -2. To your Podfile, add the OptiView Player specs source first: `source 'https://github.com/THEOplayer/cocoapods-specs.git'`, followed by the public source for third-party dependencies: `source 'https://cdn.cocoapods.org/'`. -3. To your Podfile, add the connector pods that you want to use in your app: `pod 'THEOplayer-Connector-SideloadedSubtitle'` -4. Install the pods using `pod install`, then open your `.xcworkspace` file to see the project in Xcode. +2. Add the sources and connector pod to your Podfile, including [our CocoaPods spec repo](https://optiview.dolby.com/docs/theoplayer/getting-started/sdks/ios/cocoapods-spec-repo/): + + ```ruby + source 'https://github.com/THEOplayer/cocoapods-specs' + source 'https://cdn.cocoapods.org/' + + target 'MyApp' do + pod 'THEOplayer-Connector-SideloadedSubtitle' + end + ``` + +3. Install the pods using `pod install`, then open your `.xcworkspace` file to see the project in Xcode. ## Usage diff --git a/Code/Uplynk/README.md b/Code/Uplynk/README.md index e4272b03..8b1301b3 100644 --- a/Code/Uplynk/README.md +++ b/Code/Uplynk/README.md @@ -24,12 +24,21 @@ To support custom feature builds of THEOplayerSDK perform the following steps: 1. Choose `File` > `Packages` > `Reset Package Caches` from the menu bar. 2. If it is still not working, make sure to remove any `THEOplayerSDK.xcframework` inclusions that you manually installed before installing this THEOplayer-Connector-Uplynk package. -### [Cocoapods](https://guides.cocoapods.org/using/getting-started.html#getting-started) +### [CocoaPods](https://guides.cocoapods.org/using/getting-started.html#getting-started) 1. Create a Podfile if you don't already have one. From the root of your project directory, run the following command: `pod init` -2. To your Podfile, add the OptiView Player specs source first: `source 'https://github.com/THEOplayer/cocoapods-specs.git'`, followed by the public source for third-party dependencies: `source 'https://cdn.cocoapods.org/'`. -3. To your Podfile, add the Uplynk connector pods that you want to use in your app: `pod 'THEOplayer-Connector-Uplynk'` -4. Install the pods using `pod install` , then open your `.xcworkspace` file to see the project in Xcode. +2. Add the sources and connector pod to your Podfile, including [our CocoaPods spec repo](https://optiview.dolby.com/docs/theoplayer/getting-started/sdks/ios/cocoapods-spec-repo/): + + ```ruby + source 'https://github.com/THEOplayer/cocoapods-specs' + source 'https://cdn.cocoapods.org/' + + target 'MyApp' do + pod 'THEOplayer-Connector-Uplynk' + end + ``` + +3. Install the pods using `pod install`, then open your `.xcworkspace` file to see the project in Xcode. To support custom feature builds of THEOplayerSDK perform the following steps: diff --git a/Code/Yospace/README.md b/Code/Yospace/README.md index 27761b6f..4b835a66 100644 --- a/Code/Yospace/README.md +++ b/Code/Yospace/README.md @@ -20,27 +20,39 @@ To support custom feature builds of THEOplayerSDK perform the following steps: 1. Choose `File` > `Packages` > `Reset Package Caches` from the menu bar. 2. If it is still not working, make sure to remove any `THEOplayerSDK.xcframework` inclusions that you manually installed before installing this connector package. -### [Cocoapods](https://guides.cocoapods.org/using/getting-started.html#getting-started) +### [CocoaPods](https://guides.cocoapods.org/using/getting-started.html#getting-started) 1. Create a Podfile if you don't already have one. From the root of your project directory, run the following command: `pod init` -2. To your Podfile, add the Yospace connector pod that you want to use in your app: `pod 'THEOplayer-Connector-Yospace'` +2. Add the sources and connector pod to your Podfile, including [our CocoaPods spec repo](https://optiview.dolby.com/docs/theoplayer/getting-started/sdks/ios/cocoapods-spec-repo/): + + ```ruby + source 'https://github.com/THEOplayer/cocoapods-specs' + source 'https://cdn.cocoapods.org/' + + target 'MyApp' do + pod 'THEOplayer-Connector-Yospace' + end + ``` + 3. Add the following post-install hook in your Podfile: -```ruby -post_install do |installer| - custom_framework_path = "#{installer.sandbox.root}/YOAdManagement-Release/YOAdManagement.xcframework" - - installer.pods_project.targets.each do |target| - if target.name == 'THEOplayer-Connector-Yospace' - framework_build_phase = target.frameworks_build_phase - file_ref = installer.pods_project.new_file(custom_framework_path) - - framework_build_phase.add_file_reference(file_ref) - end - end -end -``` -Check the Dependencies section below to get information on how to obtain the `YOAdManagement.xcframework` as a pod. -4. Install the pods using `pod install` , then open your `.xcworkspace` file to see the project in Xcode. + + ```ruby + post_install do |installer| + custom_framework_path = "#{installer.sandbox.root}/YOAdManagement-Release/YOAdManagement.xcframework" + + installer.pods_project.targets.each do |target| + if target.name == 'THEOplayer-Connector-Yospace' + framework_build_phase = target.frameworks_build_phase + file_ref = installer.pods_project.new_file(custom_framework_path) + + framework_build_phase.add_file_reference(file_ref) + end + end + end + ``` + Check the Dependencies section below to get information on how to obtain the `YOAdManagement.xcframework` as a pod. + +4. Install the pods using `pod install`, then open your `.xcworkspace` file to see the project in Xcode. To support custom feature builds of THEOplayerSDK perform the following steps: diff --git a/Readme.md b/Readme.md index 394e4dba..bcecae30 100644 --- a/Readme.md +++ b/Readme.md @@ -32,12 +32,16 @@ Notes: New connector releases are published to the [OptiView Player CocoaPods specs repository](https://github.com/THEOplayer/cocoapods-specs). In your `Podfile`, add this source first and keep the public CocoaPods source for third-party dependencies. Then add one or more of the OptiView Player iOS SDK Connectors, for example: ```ruby -source 'https://github.com/THEOplayer/cocoapods-specs.git' +source 'https://github.com/THEOplayer/cocoapods-specs' source 'https://cdn.cocoapods.org/' -pod 'THEOplayer-Connector-Conviva' +target 'MyApp' do + pod 'THEOplayer-Connector-Conviva' +end ``` +See [our CocoaPods spec repo](https://optiview.dolby.com/docs/theoplayer/getting-started/sdks/ios/cocoapods-spec-repo/) for more information. + ### Swift Package Manager In Xcode, go to **File > Add Package Dependencies...** and add: