Skip to content

Commit 3bdd233

Browse files
committed
Reorgs README.md and adds image
1 parent 604b41c commit 3bdd233

File tree

2 files changed

+26
-26
lines changed

2 files changed

+26
-26
lines changed

Img/03_ExamplePopup.jpeg

306 KB
Loading

README.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Starting from iOS 14.0, the API was made available for developers, but the restr
99

1010
Starting from iOS 14.5, Apple started enforcing this rule, so all users have to give their permission to obtain the IDFA.
1111

12-
IMAGE OF POPUP
12+
![Configuration](Img/03_ExamplePopup.jpeg)
1313

1414
This plugin supports the following platforms:
1515
* **iOS**
@@ -46,31 +46,6 @@ Just add this line to the `Packages/manifest.json` file of your Unity Project:
4646
2. Import the downloaded Unity package in your app.
4747

4848

49-
## Plugin configuration
50-
51-
To access the plugin configuration just go to the menu present in **Assets -> AppTrackingTransparency -> Configuration** You should see a window like this:
52-
53-
![Configuration](Img/00_PluginConfiguration.png)
54-
55-
### Editor manager status
56-
In this section you can control the current status of the editor implementation for the plugin.
57-
58-
- *Authorization Status*: Current authorization status returned by the editor implementation
59-
- *IDFA*: Current IDFA value returned by the editor implementation when the status is Authorized.
60-
- *Random IDFA*: Generates a new random IDFA value
61-
- *Reset status*: Completely reset the status of the editor implementation, simulating the status after a fresh app install.
62-
63-
### iOS Build settings
64-
65-
The plugin offers automated options for post-processing on iOS.
66-
This section allow you to configure what parts of the automatic post-processing you want to have for your project.
67-
- *Automatic postprocessing*: If enabled the automatic postprocessing for iOS will be run. If disabled, it will be completely ignored.
68-
- *Postprocessing Callback Order*: The order in which the postprocessing will be run. You can change the number so it works along other postprocessing scripts you may have in your project. The default value is 10.
69-
- *Add AppTrackingTransparency.framework*: If enabled, the automatic post-processing will automatically add the AppTrackingTrasnparency.framework as optional for compatibility with previous iOS versions.
70-
- *Add NSUserTrackingUsageDescription*: If enabled, the automatic post-processing will automatically add the required description to be displayed when requesting permission to the user.
71-
- *Tracking Usage Description*: String of text to be added as NSUserTrackingUsageDescription so it's displayed to the user when requesting permission.
72-
- *Auto-detect Info.plist file*: The NSUserTrackingUsageDescription value needs to be added to the main target's `Info.plist` file. When enabled, the auto post-processing will detect the current file and add the value in it. If disabled, you will have the option to specify the relative path for the `Info.plist` file you want to modify.
73-
7449
## Implementing the AppTrackingTransparency code
7550

7651
### Setup the manager
@@ -135,6 +110,31 @@ this.AppTrackingTransparencyManager.RequestTrackingAuthorization(authStatus =>
135110
});
136111
```
137112

113+
## Plugin configuration
114+
115+
To access the plugin configuration just go to the menu present in **Assets -> AppTrackingTransparency -> Configuration** You should see a window like this:
116+
117+
![Configuration](Img/00_PluginConfiguration.png)
118+
119+
### Editor manager status
120+
In this section you can control the current status of the editor implementation for the plugin.
121+
122+
- *Authorization Status*: Current authorization status returned by the editor implementation
123+
- *IDFA*: Current IDFA value returned by the editor implementation when the status is Authorized.
124+
- *Random IDFA*: Generates a new random IDFA value
125+
- *Reset status*: Completely reset the status of the editor implementation, simulating the status after a fresh app install.
126+
127+
### iOS Build settings
128+
129+
The plugin offers automated options for post-processing on iOS.
130+
This section allow you to configure what parts of the automatic post-processing you want to have for your project.
131+
- *Automatic postprocessing*: If enabled the automatic postprocessing for iOS will be run. If disabled, it will be completely ignored.
132+
- *Postprocessing Callback Order*: The order in which the postprocessing will be run. You can change the number so it works along other postprocessing scripts you may have in your project. The default value is 10.
133+
- *Add AppTrackingTransparency.framework*: If enabled, the automatic post-processing will automatically add the AppTrackingTrasnparency.framework as optional for compatibility with previous iOS versions.
134+
- *Add NSUserTrackingUsageDescription*: If enabled, the automatic post-processing will automatically add the required description to be displayed when requesting permission to the user.
135+
- *Tracking Usage Description*: String of text to be added as NSUserTrackingUsageDescription so it's displayed to the user when requesting permission.
136+
- *Auto-detect Info.plist file*: The NSUserTrackingUsageDescription value needs to be added to the main target's `Info.plist` file. When enabled, the auto post-processing will detect the current file and add the value in it. If disabled, you will have the option to specify the relative path for the `Info.plist` file you want to modify.
137+
138138
## Any code samples?
139139
There is a [folder](https://github.com/lupidan/unity-apptrackingtransparency/tree/main/com.lupidan.unity-apptrackingtransparency/Samples%7E) inside the plugin code containing some samples.
140140
You can also import the sample code into your project by going to the Unity Package Manager, selecting the packages In Project, and selecting the AppTrackingTransparency for Unity package. You should see an option to import a sample:

0 commit comments

Comments
 (0)