diff --git a/docs/changelog.md b/docs/changelog.md index dd60562..8ba1717 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -15,9 +15,12 @@ For detailed technical changes please refer to our [Transition Guide](transition ## Support Period -Current SDK version: __4.7.0__ +Current SDK version: __4.8.0__ Please refer to our [SDK maintenance and support policy](maintenance_policy.md) for more information about Mobile SDK maintenance and support. +## SDK Version: __4.8.0__ +![Improvement] Managing Liveness dependencies to help better conversion + ## SDK Version: __4.7.0__ ![Improvement] Datadog SDK version update to 2.0: Added possibility to have two Datadog instances at the same time. Added SPM and Carthage support for Datadog diff --git a/docs/integration_faq.md b/docs/integration_faq.md index 94975c7..427e754 100644 --- a/docs/integration_faq.md +++ b/docs/integration_faq.md @@ -81,12 +81,12 @@ The following table shows a range of different product configurations with the f | Product Configuration | Size | Modules | | :------------------------- | :----: | :-----: | -| Slim | 2.11 MB | base | -| All | 3.77 MB | base, nfc | -| All + IProov | 5.05 MB | base, nfc, iproov | -| All + DeviceRisk | 4.25 MB | base, nfc, devicerisk | -| All + DocFinder | 5.57 MB | base, nfc, docfinder | -| All + Datadog | 3.92 MB | base, nfc, datadog | +| Slim | 1.87 MB | base | +| All | 3.91 MB | base, nfc | +| All + IProov | 7.74 MB | base, nfc, iproov | +| All + DeviceRisk | 4.12 MB | base, nfc, devicerisk | +| All + DocFinder | 5.58 MB | base, nfc, docfinder | +| All + Datadog | 4.96 MB | base, nfc, datadog | | All + Liveness | 6.59 MB | base, nfc, liveness | In case you use a combination of these products, make sure to add frameworks only once to your app and that those frameworks are linked and embedded in your Xcode project. @@ -129,7 +129,7 @@ Our SDK supports localization for different languages and cultures. All label te This way, when upgrading our SDK to a newer version your localization file won't be overwritten. Make sure, that the content of this localization file is up to date after an SDK update. If you're having issues with Localization, please refer to our [Known Issues](known_issues.md#language-localization-issues) -__Note:__ If using CocoaPods, the original file is located under `/Pods/JumioMobileSDK`. +__Note:__ If using CocoaPods, the original file is located under `/Pods/Jumio/Localization`. Currently, the following languages are automatically supported for your convenience: [supported languages](../README.md#language-localization) diff --git a/docs/integration_guide.md b/docs/integration_guide.md index d837c53..48b0603 100644 --- a/docs/integration_guide.md +++ b/docs/integration_guide.md @@ -41,7 +41,7 @@ Jumio’s products allow businesses to establish the genuine identity of their u - [Custom UI customization](#custom-ui-customization) ## Release Notes -Please refer to our [Change Log](changelog.md) for more information. Current SDK version: __4.7.0__ +Please refer to our [Change Log](changelog.md) for more information. Current SDK version: __4.8.0__ For technical changes that should be considered when updating the SDK, please read our [Transition Guide](transition_guide.md). @@ -78,18 +78,18 @@ platform :ios, '11.0' use_frameworks! # Required for proper framework handling #Core (add one of these): -pod 'Jumio/Slim', '~>4.7.0' # Manual Capture functionality -pod 'Jumio/Jumio', '~>4.7.0' # Manual Capture + NFC functionality +pod 'Jumio/Slim', '~>4.8.0' # Manual Capture functionality +pod 'Jumio/Jumio', '~>4.8.0' # Manual Capture + NFC functionality #Addons: -pod 'Jumio/Liveness', '~>4.7.0' # Liveness functionality -pod 'Jumio/IProov', '~>4.7.0' # iProov liveness functionality -pod 'Jumio/DocFinder', '~>4.7.0' # Autocapture functionality -pod 'Jumio/DeviceRisk', '~>4.7.0' # Device fingerprinting functionality -pod 'Jumio/Datadog', '~>4.7.0' # Analytics functionality +pod 'Jumio/Liveness', '~>4.8.0' # Liveness functionality +pod 'Jumio/IProov', '~>4.8.0' # iProov liveness functionality +pod 'Jumio/DocFinder', '~>4.8.0' # Autocapture functionality +pod 'Jumio/DeviceRisk', '~>4.8.0' # Device fingerprinting functionality +pod 'Jumio/Datadog', '~>4.8.0' # Analytics functionality #All: -pod 'Jumio/All', '~>4.7.0' # All Jumio products with all available scanning methods, except for Jumio/DeviceRisk +pod 'Jumio/All', '~>4.8.0' # All Jumio products with all available scanning methods, except for Jumio/DeviceRisk ``` ##### Certified Face Liveness @@ -144,15 +144,15 @@ Adapt you Cartfile and add Jumio dependencies. Check the following example how a ``` #Core (always add): -binary "https://raw.githubusercontent.com/Jumio/mobile-sdk-ios/master/Carthage/Jumio.json" == 4.7.0 +binary "https://raw.githubusercontent.com/Jumio/mobile-sdk-ios/master/Carthage/Jumio.json" == 4.8.0 #Addons: -binary "https://raw.githubusercontent.com/Jumio/mobile-sdk-ios/master/Carthage/JumioDocFinder.json" == 4.7.0 -binary "https://raw.githubusercontent.com/Jumio/mobile-sdk-ios/master/Carthage/JumioIProov.json" == 4.7.0 -binary "https://raw.githubusercontent.com/Jumio/mobile-sdk-ios/master/Carthage/JumioDeviceRisk.json" == 4.7.0 -binary "https://raw.githubusercontent.com/Jumio/mobile-sdk-ios/master/Carthage/IProovDependencies.json" == 4.7.0 -binary "https://raw.githubusercontent.com/Jumio/mobile-sdk-ios/master/Carthage/JumioLiveness.json" == 4.7.0 -binary "https://raw.githubusercontent.com/Jumio/mobile-sdk-ios/master/Carthage/JumioDatadog.json" == 4.7.0 +binary "https://raw.githubusercontent.com/Jumio/mobile-sdk-ios/master/Carthage/JumioDocFinder.json" == 4.8.0 +binary "https://raw.githubusercontent.com/Jumio/mobile-sdk-ios/master/Carthage/JumioIProov.json" == 4.8.0 +binary "https://raw.githubusercontent.com/Jumio/mobile-sdk-ios/master/Carthage/JumioDeviceRisk.json" == 4.8.0 +binary "https://raw.githubusercontent.com/Jumio/mobile-sdk-ios/master/Carthage/IProovDependencies.json" == 4.8.0 +binary "https://raw.githubusercontent.com/Jumio/mobile-sdk-ios/master/Carthage/JumioLiveness.json" == 4.8.0 +binary "https://raw.githubusercontent.com/Jumio/mobile-sdk-ios/master/Carthage/JumioDatadog.json" == 4.8.0 ``` Update you Carthage dependencies via Terminal: @@ -161,7 +161,7 @@ carthage update --use-xcframeworks ``` ### Manually -Download our frameworks manually via [ios-jumio-mobile-sdk-4.7.0.zip](https://repo.mobile.jumio.ai/com/jumio/ios/jumio-mobile-sdk/4.7.0/ios-jumio-mobile-sdk-4.7.0.zip). +Download our frameworks manually via [ios-jumio-mobile-sdk-4.8.0.zip](https://repo.mobile.jumio.ai/com/jumio/ios/jumio-mobile-sdk/4.8.0/ios-jumio-mobile-sdk-4.8.0.zip). __Using iProov (manually):__ * JumioIProov.xcframework diff --git a/docs/maintenance_policy.md b/docs/maintenance_policy.md index d809d3b..4e71312 100644 --- a/docs/maintenance_policy.md +++ b/docs/maintenance_policy.md @@ -33,6 +33,7 @@ The following table is a visual representation of the SDK 4.x.x version life-cyc | Version | Release | End of Support | End of Life | |:-------:|:----------------:|:-----------------:|:----------------:| +| 4.8.0 | 17 October 2023 | 17 July 2024 | 17 October 2025 | | 4.7.0 |27 September 2023 | 27 June 2024 |27 September 2025 | | 4.6.1 |05 September 2023 | 05 June 2024 |05 September 2025 | | 4.6.0 | 05 June 2023 | 05 March 2024 | 05 June 2025 | diff --git a/docs/transition_guide.md b/docs/transition_guide.md index 2804be3..9e5c851 100644 --- a/docs/transition_guide.md +++ b/docs/transition_guide.md @@ -6,6 +6,13 @@ This section covers all technical changes that should be considered when updatin ⚠️  When updating your SDK version, __all__ changes/updates made in in the meantime have to be taken into account and applied if necessary. __Example:__ If you're updating from SDK version __3.7.2__ to __3.9.2__, the changes outlined in __3.8.0, 3.9.0__ and __3.9.1__ are __still relevant__. +## 4.8.0 +#### Manual Integration +* Framework `JumioLiveness.xcframework` is now required when using `JumioIProov.xcframework` + +#### Carthage Integration +* Framework `JumioLiveness.xcframework` is now required when using `JumioIProov.xcframework` + ## 4.7.0 #### Barcode * Removed `Jumio/Barcode` dependency as the functionality was moved to Jumio core. Every dependency now contains Barcode functionality.