Skip to content

Commit caad265

Browse files
ahakimsaidahakimsaid
authored
Update README.md
1 parent a4c2621 commit caad265

File tree

1 file changed

+147
-103
lines changed

1 file changed

+147
-103
lines changed

‎README.md‎

Lines changed: 147 additions & 103 deletions
Original file line numberDiff line numberDiff line change
@@ -1,104 +1,148 @@
1+
![alt tag](../res/ca_logo.png)
12

2-
<html>
3-
<body>
4-
<p><img alt="alt tag" src="res/ca_logo.png" /></p>
5-
<h1 id="developers-implementation-guide">Developers' Implementation Guide</h1>
6-
<p><strong>iOS</strong></p>
7-
<p>Last update : <em>18/08/2025</em><br />
8-
Release version : <em>5</em></p>
9-
<p><div id="end_first_page" /></p>
10-
11-
<div class="toc">
12-
<ul>
13-
<li><a href="#developers-implementation-guide">Developers' Implementation Guide</a></li>
14-
<li><a href="#introduction">Introduction</a></li>
15-
<li><a href="#latest-available-versions">Latest available versions</a></li>
16-
<li><a href="#adding-a-module-to-your-project">Adding a module to your project</a></li>
17-
<li><a href="#cocoapods">Cocoapods</a><ul>
18-
<li><a href="#build-variants">Build Variants</a></li>
19-
<li><a href="#xcframework">XCFramework</a></li>
20-
<li><a href="#spm-support">SPM support</a></li>
21-
<li><a href="#demo-application">Demo Application</a></li>
22-
</ul>
23-
</li>
24-
<li><a href="#support-and-contacts">Support and contacts</a></li>
25-
</ul>
26-
</div>
27-
<h1 id="introduction">Introduction</h1>
28-
<p>TagCommander for mobile is a collection of small SDKs each designed to serve a dedicated purpose.
29-
The modules are the following :</p>
30-
<p><a href="TCCore/README.md">Core : Used as a base by the other modules.</a></p>
31-
<p><a href="TCServerSide/README.md">ServerSide : Tag management system collecting data through a server-side approach.</a></p>
32-
<p><a href="TCConsent/README.md">Consent : Pass the Consent settings to our tag system</a></p>
33-
<p>For each of those modules, please check their respective documentation for more information.</p>
34-
<h1 id="latest-available-versions">Latest available versions</h1>
35-
<p>Core : <em>5.4.3</em></p>
36-
<p>ServerSide : <em>5.4.5</em></p>
37-
<p>Consent : <em>5.3.7</em></p>
38-
<p>IAB : <em>5.2.0</em></p>
39-
<p>Partners : <em>5.0.4</em></p>
40-
<h1 id="adding-a-module-to-your-project">Adding a module to your project</h1>
41-
<p>If you want to add a module to your iOS project, you have several possibilities.</p>
42-
<pre><code>- Using cocoapods to manage the dependency.
43-
- Using directly the framework files in your project.
44-
- Using SPM
45-
</code></pre>
46-
<h1 id="cocoapods">Cocoapods</h1>
47-
<div class="warning"></div>
48-
<blockquote>
49-
<p>We renamed all our pods! The names of the pod changed to be able to reflect the exact content of the podspec (and thus preventing the name warning).</p>
50-
</blockquote>
51-
<p>All latests now point toward an XCode 12 compiled version. If you still need XCode 11, please check the changelogs and point to the pod inside the latest XCode 11 release available. XCode 11 is not supported anymore and no new releases will be made for it.</p>
52-
<pre><code>pod 'latest_TCCore', :podspec =&gt; 'https://raw.githubusercontent.com/TagCommander/iOSV5/master/TCCore/latest_TCCore.podspec'
53-
pod 'latest_TCServerSide', :podspec =&gt; 'https://raw.githubusercontent.com/TagCommander/iOSV5/master/TCServerSide/latest_TCServerSide.podspec'
54-
</code></pre>
55-
<p>You can also point on a specific version (only for the latests builds):</p>
56-
<pre><code>pod 'TCCore', :podspec =&gt; 'https://raw.githubusercontent.com/TagCommander/iOSV5/master/TCCore/5/0/0/TCCore.podspec'
57-
pod 'TCServerSide', :podspec =&gt; 'https://raw.githubusercontent.com/TagCommander/iOSV5/master/TCServerSide/5/0/0/TCServerSide.podspec'
58-
</code></pre>
59-
<h2 id="build-variants">Build Variants</h2>
60-
<div class="warning"></div>
61-
<blockquote>
62-
<p>Starting with XCode 14, Apple will no longer accept releases with Bitcode, so we removed the corresponding variants.</p>
63-
</blockquote>
64-
<p>We had several variants depending on your needs, but when Bitcode was removed, we tried our best to limit as much as possible.</p>
65-
<p>Right now all modules only have one version beside:</p>
66-
<pre><code>- [for TCCore] : one regular version
67-
- [for TCServerSide] : one version without the code to get the IDFA
68-
- [for TCConsent] : one regular version
69-
- [for TCConsent] : one version made to work with IAB
70-
</code></pre>
71-
<p>The non-IDFA variant will not compile anything linked with ASIdentifierManager.</p>
72-
<h2 id="xcframework">XCFramework</h2>
73-
<p>The latest version of our modules are always available on our github account: https://github.com/TagCommander/iosv5</p>
74-
<div class="warning"></div>
75-
<blockquote>
76-
<p>You will always need to at least add the Core module to your project.</p>
77-
</blockquote>
78-
<p>Add the modules you need to your project and confirm that XCode really added them for your Target at the following places:</p>
79-
<pre><code>- In the "general" tab under "Linked Frameworks and Libraries"
80-
- In the "Build Phases" tab under "Link Binary With Libraries"
81-
- That the FRAMEWORK_SEARCH_PATHS do include the places where the frameworks are.
82-
</code></pre>
83-
<h2 id="spm-support">SPM support</h2>
84-
<p>Swift Package Manager is an easy and a simple way to install Commanders Act's iOS libraries:</p>
85-
<p>&nbsp;&nbsp;1.In Xcode, select “File” → “Swift Packages” → “Add Package Dependency”</p>
86-
<p>&nbsp;&nbsp;2.Enter https://github.com/CommandersAct/iOSV5/</p>
87-
<p>&nbsp;&nbsp;3.Choose the right products for your project</p>
88-
<p><strong>/!\ Warning :</strong></p>
89-
<p>If you need to switch your usage from SPM to cocoapods or local XCFramework, please make sur to clean your build folder.</p>
90-
<p>If you want to change products variants or add new ones, you'll need to re-add the iOSV5 package dependency and also empty your build folder.</p>
91-
<h2 id="demo-application">Demo Application</h2>
92-
<p>You can find a full example of a working app integrating our libraries in the following repo :</p>
93-
<p>https://github.com/CommandersAct/tcmobiledemo-v5</p>
94-
<h1 id="support-and-contacts">Support and contacts</h1>
95-
<p><img alt="alt tag" src="./res/ca_logo.png" /></p>
96-
<hr />
97-
<p><strong>Support</strong>
98-
<em>[email protected]</em></p>
99-
<p>http://www.commandersact.com</p>
100-
<p>Commanders Act | 7b rue taylor - 75010 PARIS - France</p>
101-
<hr />
102-
<p>This documentation was generated on 18/08/2025 16:35:19</p>
103-
</body>
104-
</html>
3+
Developers' Implementation Guide
4+
================================
5+
6+
Last update : *14/01/2026*
7+
8+
Release version : *5*
9+
10+
## Table of Contents
11+
12+
- [Developers' Implementation Guide](#developers-implementation-guide)
13+
- [Introduction](#introduction)
14+
- [Latest available versions](#latest-available-versions)
15+
- [Adding a module to your project](#adding-a-module-to-your-project)
16+
- [Cocoapods](#cocoapods)
17+
- [Build Variants](#build-variants)
18+
- [XCFramework](#xcframework)
19+
- [SPM support](#spm-support)
20+
- [Demo Application](#demo-application)
21+
- [Support and contacts](#support-and-contacts)
22+
23+
Introduction
24+
============
25+
26+
TagCommander for mobile is a collection of small SDKs each designed to serve a dedicated purpose.
27+
The modules are the following :
28+
29+
[Core : Used as a base by the other modules.](TCCore/README.md)
30+
31+
[ServerSide : Tag management system collecting data through a server-side approach.](TCServerSide/README.md)
32+
33+
[Consent : Pass the Consent settings to our tag system](TCConsent/README.md)
34+
35+
36+
For each of those modules, please check their respective documentation for more information.
37+
38+
39+
Latest available versions
40+
=========================
41+
42+
Core : *5.4.3*
43+
44+
ServerSide : *5.4.5*
45+
46+
Consent : *5.3.7*
47+
48+
IAB : *5.2.0*
49+
50+
Partners : *5.0.4*
51+
52+
Adding a module to your project
53+
===============================
54+
55+
If you want to add a module to your iOS project, you have several possibilities.
56+
57+
- Using cocoapods to manage the dependency.
58+
- Using directly the framework files in your project.
59+
- Using SPM
60+
61+
62+
Cocoapods
63+
=========
64+
65+
> [!NOTE]
66+
> We renamed all our pods! The names of the pod changed to be able to reflect the exact content of the podspec (and thus preventing the name warning).
67+
68+
All latests now point toward an XCode 12 compiled version. If you still need XCode 11, please check the changelogs and point to the pod inside the latest XCode 11 release available. XCode 11 is not supported anymore and no new releases will be made for it.
69+
70+
pod 'latest_TCCore', :podspec => 'https://raw.githubusercontent.com/TagCommander/iOSV5/master/TCCore/latest_TCCore.podspec'
71+
pod 'latest_TCServerSide', :podspec => 'https://raw.githubusercontent.com/TagCommander/iOSV5/master/TCServerSide/latest_TCServerSide.podspec'
72+
73+
You can also point on a specific version (only for the latests builds):
74+
75+
pod 'TCCore', :podspec => 'https://raw.githubusercontent.com/TagCommander/iOSV5/master/TCCore/5/0/0/TCCore.podspec'
76+
pod 'TCServerSide', :podspec => 'https://raw.githubusercontent.com/TagCommander/iOSV5/master/TCServerSide/5/0/0/TCServerSide.podspec'
77+
78+
Build Variants
79+
--------------
80+
81+
> [!NOTE]
82+
> Starting with XCode 14, Apple will no longer accept releases with Bitcode, so we removed the corresponding variants.
83+
84+
We had several variants depending on your needs, but when Bitcode was removed, we tried our best to limit as much as possible.
85+
86+
Right now all modules only have one version beside:
87+
88+
- [for TCCore] : one regular version
89+
- [for TCServerSide] : one version without the code to get the IDFA
90+
- [for TCConsent] : one regular version
91+
- [for TCConsent] : one version made to work with IAB
92+
93+
94+
The non-IDFA variant will not compile anything linked with ASIdentifierManager.
95+
96+
97+
XCFramework
98+
-----------
99+
100+
The latest version of our modules are always available on our github account: https://github.com/TagCommander/iosv5
101+
102+
> [!NOTE]
103+
> You will always need to at least add the Core module to your project.
104+
105+
Add the modules you need to your project and confirm that XCode really added them for your Target at the following places:
106+
107+
- In the "general" tab under "Linked Frameworks and Libraries"
108+
- In the "Build Phases" tab under "Link Binary With Libraries"
109+
- That the FRAMEWORK_SEARCH_PATHS do include the places where the frameworks are.
110+
111+
SPM support
112+
-----------
113+
114+
Swift Package Manager is an easy and a simple way to install Commanders Act's iOS libraries:
115+
116+
- In Xcode, select “File” → “Swift Packages” → “Add Package Dependency”
117+
118+
- Enter https://github.com/CommandersAct/iOSV5/
119+
120+
- Choose the right products for your project
121+
122+
> [!WARNING]
123+
> If you need to switch your usage from SPM to cocoapods or local XCFramework, please make sur to clean your build folder.
124+
>
125+
> If you want to change products variants or add new ones, you'll need to re-add the iOSV5 package dependency and also empty your build folder.
126+
127+
128+
Demo Application
129+
----------------
130+
131+
You can find a full example of a working app integrating our libraries in the following repo :
132+
133+
https://github.com/CommandersAct/tcmobiledemo-v5
134+
135+
Support and contacts
136+
====================
137+
![alt tag](../res/ca_logo.png)
138+
139+
***
140+
**Support**
141+
*[email protected]*
142+
143+
http://www.commandersact.com
144+
145+
Commanders Act | 7b rue taylor - 75010 PARIS - France
146+
***
147+
148+
This documentation was generated on 14/01/2026 14:33:50

0 commit comments

Comments
 (0)