From 2dee4a85c58d960a8d20249ab139afa1878d57e4 Mon Sep 17 00:00:00 2001 From: Aditi Agrawal Date: Wed, 10 Feb 2021 12:37:10 +0530 Subject: [PATCH 01/11] Update docs for SDWebImage installation guide under Manual Installation --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index efbfea25..996c6372 100644 --- a/README.md +++ b/README.md @@ -83,10 +83,13 @@ Also, follow steps to link SDWebImage into your project ### 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 +- **The 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 installating and integrating SDWebImage: + + ## 🚀 Integration From def63d4f3eb3fa9a127c385d62d24a238c911cb4 Mon Sep 17 00:00:00 2001 From: Aditi Agrawal Date: Wed, 10 Feb 2021 12:53:07 +0530 Subject: [PATCH 02/11] Add steps to install/ integrate SDWebImage --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 996c6372..db170b68 100644 --- a/README.md +++ b/README.md @@ -83,12 +83,25 @@ Also, follow steps to link SDWebImage into your project ### 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 -- **The 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 installating and integrating SDWebImage: +- Embed the framework. Select your app.xcodeproj file. Under "General", add the CleverTapSDK framework as an embedded binary. + +- **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 installating and integrating SDWebImage: + - Inside of your project folder, clone SDWebImage repository recursively. + + ``` + git clone https://github.com/SDWebImage/SDWebImage.git" + ``` + + - Add SDWebImage.xcodeproj into your Project, by dragging the SDWebImage.xcodeproj you cloned under your main Project file. + - Select your app.xcodeproj file, open "General", click the “+” button under the “Frameworks, Libraries, and Embedded Content”, and add the SDWebImage.framework aas an embedded binary. + + + ## 🚀 Integration From 727864958e7cbcde493a1970893204290e723e74 Mon Sep 17 00:00:00 2001 From: Aditi Agrawal Date: Wed, 10 Feb 2021 12:58:07 +0530 Subject: [PATCH 03/11] docs: Text Correction --- README.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index db170b68..2b7d1233 100644 --- a/README.md +++ b/README.md @@ -90,7 +90,7 @@ Also, follow steps to link SDWebImage into your project - **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 installating and integrating SDWebImage: + Please follow the steps below for installing and integrating SDWebImage: - Inside of your project folder, clone SDWebImage repository recursively. ``` @@ -98,11 +98,8 @@ Also, follow steps to link SDWebImage into your project ``` - Add SDWebImage.xcodeproj into your Project, by dragging the SDWebImage.xcodeproj you cloned under your main Project file. - - Select your app.xcodeproj file, open "General", click the “+” button under the “Frameworks, Libraries, and Embedded Content”, and add the SDWebImage.framework aas an embedded binary. + - Select your app.xcodeproj file, open "General", click the "+" button under the "Frameworks, Libraries, and Embedded Content", and add the SDWebImage.framework aas an embedded binary. - - - ## 🚀 Integration From 170e304c14cdf9438acc8c9a3b0e40af8e5a8842 Mon Sep 17 00:00:00 2001 From: Aditi Agrawal Date: Wed, 10 Feb 2021 13:17:59 +0530 Subject: [PATCH 04/11] docs: fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2b7d1233..08b14840 100644 --- a/README.md +++ b/README.md @@ -94,7 +94,7 @@ Also, follow steps to link SDWebImage into your project - Inside of your project folder, clone SDWebImage repository recursively. ``` - git clone https://github.com/SDWebImage/SDWebImage.git" + git clone https://github.com/SDWebImage/SDWebImage.git ``` - Add SDWebImage.xcodeproj into your Project, by dragging the SDWebImage.xcodeproj you cloned under your main Project file. From 4806b59421de900c250bb24dd0554abec8c802c5 Mon Sep 17 00:00:00 2001 From: Aditi Agrawal Date: Wed, 10 Feb 2021 15:34:52 +0530 Subject: [PATCH 05/11] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 08b14840..3e0fe4cc 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,7 @@ Also, follow steps to link SDWebImage into your project ``` - Add SDWebImage.xcodeproj into your Project, by dragging the SDWebImage.xcodeproj you cloned under your main Project file. - - Select your app.xcodeproj file, open "General", click the "+" button under the "Frameworks, Libraries, and Embedded Content", and add the SDWebImage.framework aas an embedded binary. + - Select your app.xcodeproj file, open "General", click the "+" button under the "Frameworks, Libraries, and Embedded Content", and add the SDWebImage.framework as an embedded binary. ## 🚀 Integration From ac3bac0bcf6f4cd5e894ddb2e367a199b52ddf34 Mon Sep 17 00:00:00 2001 From: Aditi Agrawal Date: Wed, 10 Feb 2021 16:13:46 +0530 Subject: [PATCH 06/11] Update Manual Installation Guide --- README.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 3e0fe4cc..7dd1146e 100644 --- a/README.md +++ b/README.md @@ -82,23 +82,19 @@ Also, follow steps to link SDWebImage into your project ### Manually -- Download the latest framework [release](https://github.com/CleverTap/clevertap-ios-sdk/releases). Unzip the download. - +- 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. -- Embed the framework. Select your app.xcodeproj file. Under "General", add the CleverTapSDK framework as an embedded binary. +- Embed the framework. Select your app.xcodeproj file, open "General", add the CleverTapSDK framework as an embedded binary. - **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 installing and integrating SDWebImage: - - Inside of your project folder, clone SDWebImage repository recursively. - - ``` - git clone https://github.com/SDWebImage/SDWebImage.git - ``` - - - Add SDWebImage.xcodeproj into your Project, by dragging the SDWebImage.xcodeproj you cloned under your main Project file. - - Select your app.xcodeproj file, open "General", click the "+" button under the "Frameworks, Libraries, and Embedded Content", and add the SDWebImage.framework as an embedded binary. + Please follow the steps below for integrating SDWebImage: + - Navigate to the cloned CleverTap iOS SDK repository and from Vendors directory, add SDWebImage.xcodeproj into your Project, by dragging the SDWebImage.xcodeproj under your main Project file. + - Embed SDWebImage framework. Select your app.xcodeproj file, open "General", click the "+" button under the "Frameworks, Libraries, and Embedded Content", and add the SDWebImage.framework as an embedded binary. ## 🚀 Integration From a82464d1917ab7389a8932f08dee4a2cd027b6f0 Mon Sep 17 00:00:00 2001 From: Aditi Agrawal Date: Wed, 10 Feb 2021 16:30:23 +0530 Subject: [PATCH 07/11] Update Manual Installation Steps --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7dd1146e..1f2a25b0 100644 --- a/README.md +++ b/README.md @@ -86,15 +86,15 @@ Also, follow steps to link SDWebImage into your project ``` 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. - -- Embed the framework. Select your app.xcodeproj file, open "General", add the CleverTapSDK framework as an embedded binary. +- 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 cloned CleverTap iOS SDK repository and from Vendors directory, add SDWebImage.xcodeproj into your Project, by dragging the SDWebImage.xcodeproj under your main Project file. - - Embed SDWebImage framework. Select your app.xcodeproj file, open "General", click the "+" button under the "Frameworks, Libraries, and Embedded Content", and add the SDWebImage.framework as an embedded binary. + - Navigate to the cloned CleverTap iOS SDK repository and drag-n-drop `SDWebImage.xcodeproj` into your Project under your main Project file from `Vendors/SDWebImage` directory. + +- Navigate to the project application’s target settings, open "General", click the "+" button under the "Frameworks, Libraries, and Embedded Content", and add `CleverTapSDK.framework` and `SDWebImage.framework` as an embedded binary. + ## 🚀 Integration From 05f418d5f877e56b95292499864a9144758b5cf9 Mon Sep 17 00:00:00 2001 From: Aditi Agrawal Date: Wed, 10 Feb 2021 16:50:41 +0530 Subject: [PATCH 08/11] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1f2a25b0..37812d2c 100644 --- a/README.md +++ b/README.md @@ -91,7 +91,8 @@ Also, follow steps to link SDWebImage into your project - **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 cloned CleverTap iOS SDK repository and drag-n-drop `SDWebImage.xcodeproj` into your Project under your main Project file from `Vendors/SDWebImage` directory. + - Navigate to the `Vendors/SDWebImage` directory found under cloned CleverTap iOS SDK repository + - Drag-n-drop `SDWebImage.xcodeproj` into your Project under your main Project file. - Navigate to the project application’s target settings, open "General", click the "+" button under the "Frameworks, Libraries, and Embedded Content", and add `CleverTapSDK.framework` and `SDWebImage.framework` as an embedded binary. From 12c4114b5a4b5aa29c93973362083c44710eeda2 Mon Sep 17 00:00:00 2001 From: Aditi Agrawal Date: Thu, 11 Feb 2021 08:28:01 +0530 Subject: [PATCH 09/11] docs: typo fixes --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 37812d2c..ca51b41e 100644 --- a/README.md +++ b/README.md @@ -91,8 +91,8 @@ Also, follow steps to link SDWebImage into your project - **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 cloned CleverTap iOS SDK repository - - Drag-n-drop `SDWebImage.xcodeproj` into your Project under your main Project file. + - Navigate to the `Vendors/SDWebImage` directory found under the cloned CleverTap iOS SDK repository. + - Drag-n-drop `SDWebImage.xcodeproj` into the main file. - Navigate to the project application’s target settings, open "General", click the "+" button under the "Frameworks, Libraries, and Embedded Content", and add `CleverTapSDK.framework` and `SDWebImage.framework` as an embedded binary. From 356870225edec73671c995101c1c5f6afd273978 Mon Sep 17 00:00:00 2001 From: Aditi Agrawal Date: Thu, 11 Feb 2021 09:03:52 +0530 Subject: [PATCH 10/11] docs: Minor fixes in Manual Installation Steps --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ca51b41e..bf246241 100644 --- a/README.md +++ b/README.md @@ -92,9 +92,9 @@ Also, follow steps to link SDWebImage into your project 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 file. + - 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", and add `CleverTapSDK.framework` and `SDWebImage.framework` as an embedded binary. +- 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. From 35de17d01f00579ff4e0f3a32921cf305bc60516 Mon Sep 17 00:00:00 2001 From: Aditi Agrawal Date: Thu, 11 Feb 2021 16:43:34 +0530 Subject: [PATCH 11/11] Update README.md Add additional tip under Manual installation --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bf246241..d371ae6a 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,9 @@ 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 +### 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: ``` @@ -97,7 +99,6 @@ Also, follow steps to link SDWebImage into your project - 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 #### Add your CleverTap account credentials