Skip to content

Commit dd4b6e3

Browse files
authored
Update README.md (#159)
1 parent 4e4932b commit dd4b6e3

File tree

1 file changed

+17
-18
lines changed

1 file changed

+17
-18
lines changed

README.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,10 @@ Teads allows you to integrate a single SDK into your app, and serve premium bran
1212

1313
The best way to see the working integration is to clone this repository, open it with Xcode, and run the project. The sample contains multiples kinds of integrations from direct integration to integrations using mediations partners such as AdMob, Mopub, Smart.
1414

15-
--
1615

1716
# Direct integration
1817

19-
*For setup through mediation partners check those [steps](#setup-for-mediations).*
18+
*To setup through mediation partners check those [steps](#setup-for-mediations).*
2019

2120

2221
## Install the Teads SDK iOS framework
@@ -25,25 +24,25 @@ Teads SDK is currently distributed through CocoaPods. It includes everything you
2524

2625
### Cocoapods
2726

28-
For installing TeadsSDK just put this on your podfile, if you never use cocoapods before please check the [offical documentation](https://guides.cocoapods.org/using/using-cocoapods.html).
27+
To install the TeadsSDK just put this on your podfile, if you've never used cocoapods before please check the [offical documentation](https://guides.cocoapods.org/using/using-cocoapods.html).
2928

3029
```ruby
3130
pod 'TeadsSDK', '~> 5.0'
3231
```
3332

34-
Go to the directory containing your project's `.xcodeproj` file and the Podfile, on the terminal and run `pod install` command. This will install Teads SDK along with our needed dependencies.
33+
On your terminal, go to the directory containing your project's `.xcodeproj` file and your Podfile and run `pod install` command. This will install Teads SDK along with our needed dependencies.
3534

36-
```
37-
$ pod install -repo-update
35+
```bash
36+
pod install --repo-update
3837
```
3938

4039
## Migrating from v4 to v5
4140

42-
In the v5 of the SDK, we've introduced a new class called `TeadsInReadAdPlacement` which is responsible of configuring the ad request and then make the call.
41+
In SDK's v5, we've introduced a new class called `TeadsInReadAdPlacement` which is responsible of configuring the ad request and then make the call.
4342

4443
### Rename your ad view
4544

46-
From now on, we have replaced the old class `TFAInReadAdView` with a new one called `TeadsInReadAdView`. So you just need to rename it, in code and do not forget your storyboards if you are using it.
45+
We've replaced the old class `TFAInReadAdView` with a new one called `TeadsInReadAdView`. All you need to do is renaming it (don't forget your storyboard or nib files if needed).
4746

4847
```swift
4948
var teadsAdView: TeadsInReadAdView
@@ -78,7 +77,7 @@ placement = Teads.createInReadPlacement(pid: <#YOUR_PID#>, delegate: self)
7877
```
7978

8079
--
81-
**(Optional)** Pass configurations to the adPlacement, note this could be mandatory if your app have to manage the privacies consent, more details about [TeadsAdPlacementSettings](#teadsadplacementsettings).
80+
**(Optional)** Add settings to the adPlacement initialization parameters, note this could be mandatory if your app have to manage the privacies consent, more details about [TeadsAdPlacementSettings](#teadsadplacementsettings).
8281

8382
```swift
8483
let pSettings = TeadsAdPlacementSettings { (settings) in
@@ -92,7 +91,7 @@ For more information about the user privacies consent, see this [documentation]
9291
--
9392
### Request an Ad
9493

95-
You can then request an ad using the placement you have just created. Do not forget to provide your article url (if applicable) through `TeadsAdRequestSettings`. To know more about `TeadsAdRequestSettings` parameters check [this](#teadsadrequestsettings).
94+
You can then request an ad using the placement you've just created. Do not forget to provide your article url (if applicable) through `TeadsAdRequestSettings`. To know more about `TeadsAdRequestSettings` parameters check [this](#teadsadrequestsettings).
9695

9796
```swift
9897
let adSettings = TeadsAdRequestSettings(build: { (settings) in
@@ -108,7 +107,7 @@ The old `TFAAdDelegate` has been replaced by two new delegates `TeadsInReadAdPla
108107

109108
#### Implement the TeadsInReadAdPlacementDelegate
110109

111-
The TeadsInReadAdPlacementDelegate has 4 methods that you need to implement. This delegate responsability is the ad loading process, for example to tell the app when it received an ad or when the ad server failed to deliver one.
110+
The TeadsInReadAdPlacementDelegate owns 4 methods that you need to implement. This delegate is reacting to the ad loading process, for example to let the app know when an ad is received or when the ad server failed to deliver one.
112111

113112
```swift
114113
extension <#YOURViewController#>: TeadsInReadAdPlacementDelegate {
@@ -140,9 +139,9 @@ extension <#YOURViewController#>: TeadsInReadAdPlacementDelegate {
140139
#### TeadsAdOpportunityTrackerView
141140

142141
The `TeadsAdOpportunityTrackerView` is a view that you will need to add to your slot view *(e.g. the view where you will display the ad)*.
143-
This view will be provided during the ad request process and will allow Teads to monitor precisely ad opportunities on [**Teads for Publisher**](https://publishers.teads.tv/).
142+
This view will be provided during the ad request process and will allow Teads to monitor with precision ad opportunities on [**Teads for Publisher**](https://publishers.teads.tv/).
144143

145-
You should add it where the ad will be displayed, even if you don't received an ad from our SDK.
144+
You should add it where the ad will be displayed, even if you didn't have received an ad from our SDK.
146145
This view needs to be at the origin of your ad slot `(x:0, y:0)`.
147146

148147
Once the `TeadsAdOpportunityTrackerView` is visible, it will be automatically removed by the SDK.
@@ -158,7 +157,7 @@ func adOpportunityTrackerView(trackerView: TeadsAdOpportunityTrackerView) {
158157

159158
### Implement the TeadsAdDelegate
160159

161-
The TeadsAdDelegate has 5 methods that you need to implement. It is responsible for following the lifecycle of an ad, the impression, when the user taps on it when an ad it shows and even when the user closes the ad.
160+
The TeadsAdDelegate own 5 methods that you need to implement. This delegate is reacting to the ad lifecycle (e.g. impressions, clicks, ad close, modal presentation...).
162161

163162
```swift
164163
extension <#YOURViewController#>: TeadsAdDelegate {
@@ -196,7 +195,7 @@ extension <#YOURViewController#>: TeadsAdDelegate {
196195
}
197196
```
198197

199-
Note: didRecordImpression and didRecordClick are for your analytics if you have some, otherwise it could be empty.
198+
Note: didRecordImpression and didRecordClick are provided for your analytics if you have some, otherwise it could be empty.
200199

201200
You are all set! You can now display Teads ads inside your app. 🎉
202201

@@ -229,7 +228,7 @@ When you request an ad with the adPlacement you can pass customs settings.
229228

230229
## TeadsAdPlacementSettings
231230

232-
* `disableCrashMonitoring()`, disallows the SDK to add battery informations to our logs.
233-
* `disableBatteryMonitoring()`, disallows the SDK to send crash logs to our servers.
234-
* `disableTeadsAudioSessionManagement()`, if you have custom sound session management you need to disable our audio sessio management and implement the TeadsSoundDelegate.
231+
* `disableCrashMonitoring()`, disallows the SDK to send crash logs to our servers.
232+
* `disableBatteryMonitoring()`, disallows the SDK to add battery informations to our logs.
233+
* `disableTeadsAudioSessionManagement()`, if you have custom sound session management you need to disable our audio session management and implement the TeadsSoundDelegate.
235234
{"mode":"full","isActive":false}

0 commit comments

Comments
 (0)