Skip to content

Commit 09bdb0d

Browse files
authored
Update the readme to describe adding the SDK as a framework dependency. (#742)
1 parent e3dd669 commit 09bdb0d

File tree

5 files changed

+28
-1
lines changed

5 files changed

+28
-1
lines changed

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,33 @@ You can also install by downloading the raw files below.
102102
* The testbed project:
103103
[https://s3-us-west-1.amazonaws.com/branchhost/Branch-iOS-TestBed.zip](https://s3-us-west-1.amazonaws.com/branchhost/Branch-iOS-TestBed.zip)
104104

105+
##### Adding the Raw Files Branch SDK to Your Project
106+
107+
If you want to add the Branch SDK directly without using Cocoapods or Carthage, add Branch as a dynamic framework dependency to your project.
108+
109+
I'll add Branch to the project 'BareBones' as an example:
110+
111+
1. Download or git clone the Branch SDK files to your computer.
112+
113+
2. If you've already added Branch to your project, remove it.
114+
115+
3. In the Xcode project navigator view, select your project, right click, and select 'Add files to "\<your project name\>"...'
116+
117+
![Add Files...](docs/images/AddBranchProject-1-AddFiles.png "Add Files...")
118+
119+
4. The 'Add' file chooser will open. Navigate to your 'ios-branch-deep-linking > carthage-files' directory and select the BranchSDK.xcodeproj project.
120+
121+
![Add BranchSDK.xcodeproj](docs/images/AddBranchProject-2-Choose-BranchSDK.png "Add BranchSDK.xcodeproj")
122+
123+
Xcode will add BranchSDK.xcodeproj to your project.
124+
125+
5. In your project, reveal the 'BranchSDK.xcodeproj > Products' hierarchy. Then drag the Branch.framework product to the 'Embedded Binaries' section of your build product.
126+
127+
![Embed Binary](docs/images/AddBranchProject-3-Add-Framework.gif "Embed Binary")
128+
129+
6. Done! You can click on Build Phases of your project to make sure that Branch was added as a Target Dependency and is copied as an Embedded Framework.
130+
131+
![Check Build Phase](docs/images/AddBranchProject-4-BuildPhase.png "Check Build Phase")
105132

106133
### Register Your App
107134

@@ -929,7 +956,7 @@ The optional `- (void) branchShareLink:didComplete:withError:` delegate method w
929956

930957
###### Objective-C
931958
```objc
932-
@interface ViewController () <BranchShareLinkDelegate>
959+
@interface ViewController () <BranchShareLinkDelegate>
933960
```
934961
Override the branchShareLinkWillShare function to change your shareText
935962
147 KB
Loading
614 KB
Loading
373 KB
Loading
194 KB
Loading

0 commit comments

Comments
 (0)