Skip to content

Commit

Permalink
Merge pull request #101 from CleverTap/update-docs
Browse files Browse the repository at this point in the history
SDK-661: Update Manual Installation Guide
  • Loading branch information
Aditi3 authored Feb 16, 2021
2 parents ecf3582 + 35de17d commit 4c4e6cc
Showing 1 changed file with 18 additions and 7 deletions.
25 changes: 18 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,13 +80,24 @@ Also, follow steps to link SDWebImage into your project
* Select clevertap-ios-sdk under Checkouts
* Drag the built `SDWebImage.framework` from Vendors into your Frameworks and Libraries

### Manually

- Download the latest framework [release](https://github.com/CleverTap/clevertap-ios-sdk/releases). Unzip the download.

- Add the CleverTapSDK.xcodeproj to your Xcode Project, by dragging the CleverTapSDK.xcodeproj under the main project file.

- Embed the framework. Select your app.xcodeproj file. Under "General", add the CleverTapSDK framework as an embedded binary
### Manual
| :bulb: We strongly recommend that you implement the SDK via a [CocoaPod](http://cocoapods.org/). However, if you are unable to do so you may complete installation manually using our manual integration instructions below. |
|-----------------------------------------|

- Clone the CleverTap iOS SDK repository recursively:
```
git clone --recursive https://github.com/CleverTap/clevertap-ios-sdk.git
```
- Add the `CleverTapSDK.xcodeproj` to your Xcode Project, by dragging the `CleverTapSDK.xcodeproj` under the main project file.

- **SDWebImage Integration:** This library provides an async image downloader with cache support. We are using the SDWebImage cache library in our engagement channels. For example, CleverTap App Inbox uses SDWebImage for image cache and async loading for the image, another example would be CleverTap In-Apps that provides support to display gifs.

Please follow the steps below for integrating SDWebImage:
- Navigate to the `Vendors/SDWebImage` directory found under the cloned CleverTap iOS SDK repository.
- Drag-n-drop `SDWebImage.xcodeproj` into the main Project file.

- Navigate to the project application’s target settings, open "General", click the "+" button under the "Frameworks, Libraries, and Embedded Content", add `CleverTapSDK.framework` and `SDWebImage.framework` as an embedded binary.


## 🚀 Integration

Expand Down

0 comments on commit 4c4e6cc

Please sign in to comment.