Skip to content

Commit

Permalink
[Doc] - Few edits to make it look better
Browse files Browse the repository at this point in the history
  • Loading branch information
PravinPK committed Jun 24, 2021
1 parent 461d39d commit caaefae
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 11 deletions.
4 changes: 2 additions & 2 deletions Documentation/MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@

If you are in the process of migration or already migrated to AEPCore from ACPCore then you must use AEPAssurance 3.x.x in your application. For more information see [Migrate to Swift SDK](https://aep-sdks.gitbook.io/docs/resources/migrate-to-swift).

Following table shows the SDK Core's compatibility with AEPAssurance.
The following table shows the SDK Core's compatibility with AEPAssurance:

| SDK Core | Assurance Version | Pod Installation | Manual Install |
| ----------- | -------- | ---------- | ------- |
| ACPCore | AEPAssurance 1.x | pod 'AEPAssurance', '~> 1.0' | [Available Here](https://github.com/Adobe-Marketing-Cloud/acp-sdks/tree/master/iOS/AEPAssurance)|
| AEPCore | AEPAssurance 3.x | pod 'AEPAssurance', '~> 3.0' | [Follow this command](../#1-binaries) |
| AEPCore | AEPAssurance 3.x | pod 'AEPAssurance', '~> 3.0' | [Follow this command](../#binaries) |

---

Expand Down
5 changes: 2 additions & 3 deletions Documentation/MIGRATIONObjC.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ Open the `Podfile` of your application and make the following changes.
- pod `AEPAssurance`, '~> 1.0'

+ pod 'AEPCore'
+ pod 'AEPServices'
+ pod `AEPAssurance`, '~> 3.0'
```

Expand All @@ -18,7 +17,7 @@ Then run `pod install` and build the project, now the project will be using the
## 1.b. Manual Install
Please ignore this section if you are using CocoaPods or Swift Package Manager to manage dependencies.
- Remove the existing `AEPAssurance.xcframework` from your project.
- Create and Install the latest `AEPAssurance.xcframework` by following [this command]().
- Create and Install the latest `AEPAssurance.xcframework` by following [this command](../#binaries).

## 2. Registration of Assurance Extension

Expand All @@ -35,7 +34,7 @@ The following changes should be made in your AppDelegate's `didFinishLaunchingWi
+ ...
+
+ NSArray* extensionsToRegister = @[AEPMobileAssurance.class];
+ [AEPMobileAssurance registerExtensions:extensionsToRegister completion:^{
+ [AEPMobileCore registerExtensions:extensionsToRegister completion:^{
+ [AEPMobileCore configureWithAppId: @"Your_AppID"];
+ }];
+
Expand Down
5 changes: 2 additions & 3 deletions Documentation/MIGRATIONSWIFT.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ Open the `Podfile` of your application and make the following changes.
- pod `AEPAssurance`, '~> 1.0'

+ pod 'AEPCore'
+ pod 'AEPServices'
+ pod `AEPAssurance`, '~> 3.0'
```

Expand All @@ -17,11 +16,11 @@ Then run `pod install` and build the project, now the project will be using the
## 1.b. Manual Install
Please ignore this section if you are using CocoaPods or Swift Package Manager to manage dependencies.
- Remove the existing `AEPAssurance.xcframework` from your project.
- Create and Install the latest `AEPAssurance.xcframework` by following [this command]().
- Create and Install the latest `AEPAssurance.xcframework` by following [this command](../#binaries).

## 2. Registration of Assurance Extension

Make the following changes in your AppDelegate's `didFinishLaunchingWithOptions` method. If you are working with an ObjectiveC application, follow this [document](../MIGRATIONObjC.md).
Make the following changes in your AppDelegate's `didFinishLaunchingWithOptions` method. If you are working with an Objective-C application, follow this [document](../MIGRATIONObjC.md).

```diff
- AEPAssurance.registerExtension()
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Assurance/Project Griffon is a new, innovative beta product from [Adobe Experien

## Installation

### 1. Binaries
### Binaries

To generate an `AEPAssurance.xcframework`, run the following command:

Expand All @@ -20,7 +20,7 @@ $ make archive

This generates the xcframework under the `build` folder. Drag and drop all the `.xcframeworks` to your app target in Xcode.

### 2. [CocoaPods](https://guides.cocoapods.org/using/using-cocoapods.html)
### [CocoaPods](https://guides.cocoapods.org/using/using-cocoapods.html)

```ruby
# Podfile
Expand All @@ -37,7 +37,7 @@ Replace `YOUR_TARGET_NAME` and then, in the `Podfile` directory, type:
$ pod install
```

### 3. [Swift Package Manager](https://github.com/apple/swift-package-manager)
### [Swift Package Manager](https://github.com/apple/swift-package-manager)

To add the AEPAssurance Package to your application, from the Xcode menu select:

Expand Down

0 comments on commit caaefae

Please sign in to comment.