Skip to content

Commit d7aeef0

Browse files
committed
Update the migration guide for modularity
1 parent da08182 commit d7aeef0

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

MIGRATION_GUIDE.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,28 @@ As mentioned above, the iOS SDK is making the jump from `v3` to `v5`, in order t
6060
```
6161

6262
### Option 1. Swift Package Manager
63-
Update the version of the OneSignal-XCFramework your application uses to `5.0.0`. In addition, the Package Product name has been changed from `OneSignal` to `OneSignalFramework`. See [the existing installation instructions](https://documentation.onesignal.com/docs/swift-package-manager-setup).
63+
- Update the version of the OneSignal-XCFramework your application uses to `5.0.0`.
64+
- The Package Product `OneSignal` has been renamed to `OneSignalFramework`.
65+
- Location functionality has moved to its own Package Product `OneSignalLocation`. If you do not explicitly add this product your app you will not have location functionality. If you include location functionality ensure that your app also depends on the `CoreLocation` framework.
66+
- In App Messaging functionality has moved to its own Package Product `OneSignalInAppMessages`. If you do not explicitly add this product your app you will not have in app messaging functionality. If you include In App Messaging functionality ensure that your app also depends on the `WebKit` framework.
67+
- See [the existing installation instructions](https://documentation.onesignal.com/docs/swift-package-manager-setup).
6468

6569
### Option 2. CocoaPods
66-
Update the version of the OneSignalXCFramework your application uses to `5.0.0`. Other than updating the import statement above, there are no additional changes needed to import the OneSignal SDK in your Xcode project. See [the existing installation instructions](https://documentation.onesignal.com/docs/ios-sdk-setup#step-3-import-the-onesignal-sdk-into-your-xcode-project).
70+
The OneSignal pod has added additional subspecs for improved modularity. If you would like to exclude Location or In App Messaging functionality from your app you can do so by using subspecs:
71+
```
72+
pod 'OneSignal/OneSignal', '>= 5.0.0', '< 6.0'
73+
# Remove either of the following if the functionality is unwanted
74+
pod 'OneSignal/OneSignalLocation', '>= 5.0.0', '< 6.0'
75+
pod 'OneSignal/OneSignalInAppMessages', '>= 5.0.0', '< 6.0'
76+
```
77+
If you would like to include all of OneSignal's functionality you are still able to use the default pod
78+
```
79+
pod 'OneSignal', '>= 5.0.0', '< 6.0'
80+
```
81+
- Update the version of the OneSignalXCFramework your application uses to `5.0.0`.
82+
- Location functionality has moved to its own subspec `OneSignalLocation`. If you include location functionality ensure that your app also depends on the `CoreLocation` framework.
83+
- In App Messaging functionality has moved to its own subspec `OneSignalInAppMessages`. If you include In App Messaging functionality ensure that your app also depends on the `WebKit` framework.
84+
- See [the existing installation instructions](https://documentation.onesignal.com/docs/ios-sdk-setup#step-3-import-the-onesignal-sdk-into-your-xcode-project).
6785

6886
# API Changes
6987
## Namespaces

0 commit comments

Comments
 (0)