From 8d532e8b980c7ab53f532b240d243ae12a1a47e1 Mon Sep 17 00:00:00 2001 From: asklausen Date: Tue, 1 Aug 2023 11:48:53 +0100 Subject: [PATCH] DEP-398: Updates --- README.md | 20 ++++++++++---------- example/README.md | 2 +- example/android/app/build.gradle | 2 +- example/android/build.gradle | 2 +- example/ios/Demo/AppDelegate.h | 7 ------- example/ios/Demo/AppDelegate.m | 7 ------- example/ios/Demo/main.m | 7 ------- 7 files changed, 13 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 4bae4d6..0dbd00b 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # Yoti IDV, React Native -[![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/getyoti/yoti-doc-scan-react-native?label=latest%20release)](https://github.com/getyoti/yoti-doc-scan-react-native/releases) +[![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/getyoti/yoti-doc-scan-react-native?label=latest%20release)](https://github.com/getyoti/yoti-doc-scan-react-native/releases) [![Publish Release](https://github.com/getyoti/yoti-doc-scan-react-native/workflows/Publish%20Release/badge.svg)](https://github.com/getyoti/yoti-doc-scan-react-native/actions?query=workflow%3A%22Publish+Release%22) ![Illustration](./Illustration.png) -A react native wrapper of Yoti IDV for [Android](https://github.com/getyoti/yoti-doc-scan-android) and [iOS](https://github.com/getyoti/yoti-doc-scan-ios). Yoti IDV allows a user of your app to take a photo of their document, as well as to scan or capture their face, we then verify this instantly and prepare a response, which your system can then retrieve on your hosted site.s +A react native wrapper of Yoti IDV for [Android](https://github.com/getyoti/yoti-doc-scan-android) and [iOS](https://github.com/getyoti/yoti-doc-scan-ios). Yoti IDV allows a user of your app to take a photo of their document, as well as to scan or capture their face, we then verify this instantly and prepare a response, which your system can then retrieve on your hosted site. ## Prerequisites To integrate with Yoti IDV, a working infrastructure is needed (see [developers.yoti.com](https://developers.yoti.com/identity-verification/overview) for more details or get in touch with us [here](https://developers.yoti.com/support)). @@ -26,7 +26,7 @@ Continuing with your integration for Android, add the following property and rep ```groovy buildscript { ext { - yotiSdkVersion = "3.1.0" + yotiSdkVersion = "3.1.1" } } allprojects { @@ -76,7 +76,7 @@ target 'TargetName' do pod 'YotiSDKFaceCapture' // Optional end ``` -In addition, you should add [`NSCameraUsageDescription`](https://developer.apple.com/documentation/bundleresources/information_property_list/nscamerausagedescription) to your `Info.plist`. +In addition, you should add [`NSCameraUsageDescription`](https://developer.apple.com/documentation/bundleresources/information_property_list/nscamerausagedescription) to your `Info.plist`. And if you have included `YotiSDKIdentityDocument` in your target, make sure to also: - Add [`NFCReaderUsageDescription`](https://developer.apple.com/documentation/bundleresources/information_property_list/nfcreaderusagedescription) to your `Info.plist` @@ -86,10 +86,10 @@ And if you have included `YotiSDKIdentityDocument` in your target, make sure to ## Usage ### 1. Import module ```javascript -import RNYotiDocScan from '@getyoti/-yoti-doc-scan-react-native'; +import RNYotiDocScan from '@getyoti/yoti-doc-scan-react-native'; ``` ### 2. Launch a session -Launch a session with its required parameters using the `startSession` function. +Launch a session with its required parameters using the `startSession` function. ```javascript const successCallback = (code, description) => { ... @@ -105,11 +105,11 @@ On iOS, you can set the primary color using the following API: ```javascript RNYotiDocScan.setPrimaryColorRGB(0, 0, 0); // default: (34, 157, 255) ``` -To customize the colors on Android, please refer to its separate [documentation](https://github.com/getyoti/yoti-doc-scan-android#colours). +To customize the colors on Android, please refer to its separate [documentation](https://github.com/getyoti/yoti-doc-scan-android#colours). In addition, you can choose to also specify a request code on Android: ```javascript -YotiDocScan.setRequestCode(0); // default: 9001 +RNYotiDocScan.setRequestCode(0); // default: 9001 ``` ## Supported languages @@ -155,7 +155,7 @@ Code | Description 7000 | The user did not have the required documents ## Support -If you have any questions, please do not hesitate to contact clientsupport@yoti.com. Once we have answered your question, we may contact you again to discuss Yoti products and services. If you'd prefer us not to do this, please let us know when you e-mail. +For any questions or support please contact us [here](https://support.yoti.com). Once we have answered your question, we may contact you again to discuss Yoti products and services. If you'd prefer us not to do this, please let us know when you e-mail. ## Licence -See the licence for our SDK [here](https://www.yoti.com/terms/identity-verification). +See the licence [here](https://www.yoti.com/terms/identity-verification). diff --git a/example/README.md b/example/README.md index b178cca..a56de02 100644 --- a/example/README.md +++ b/example/README.md @@ -9,7 +9,7 @@ To run this example, a working working React Native environment is needed (see [ Install the wrapper's dependencies by running `yarn install` from the `example` directory, and then proceed to the relevant platform section below. ### Android -To continue your installation with Android, you should run `yarn start` and `adb -s DEVICE_ID_HERE reverse tcp:8081 tcp:8081` (or `adb reverse tcp:8081 tcp:8081` if using a simulator) from the `example` directory. , and then open the `example/android` project in Android Studio. You can now sync Gradle and build the app. +To continue your installation with Android, you should run `yarn start` and `adb -s DEVICE_ID_HERE reverse tcp:8081 tcp:8081` (or `adb reverse tcp:8081 tcp:8081` if using an emulator) from the `example` directory. , and then open the `example/android` project in Android Studio. You can now sync Gradle and build the app. ### iOS To continue your installation with iOS, you should run `pod install` from the `example/ios` directory, and then open the project in Xcode through the `Demo.xcworkspace` file. diff --git a/example/android/app/build.gradle b/example/android/app/build.gradle index 292ed13..1f83677 100644 --- a/example/android/app/build.gradle +++ b/example/android/app/build.gradle @@ -79,7 +79,7 @@ dependencies { implementation "com.facebook.react:react-native:0.68.5" implementation "com.yoti.mobile.android.sdk:yoti-sdk-doc-scan:${rootProject.ext.yotiSdkVersion}" //implementation "com.yoti.mobile.android.sdk:yoti-sdk-doc-scan-sup:${rootProject.ext.yotiSdkVersion}" - //implementation "com.yoti.mobile.android.sdk:yoti-sdk-liveness-zoom:${rootProject.ext.yotiSdkVersion}" + implementation "com.yoti.mobile.android.sdk:yoti-sdk-liveness-zoom:${rootProject.ext.yotiSdkVersion}" //implementation "com.yoti.mobile.android.sdk:yoti-sdk-facecapture:${rootProject.ext.yotiSdkVersion}" // With embedded AI model //implementation "com.yoti.mobile.android.sdk:yoti-sdk-facecapture-unbundled:${rootProject.ext.yotiSdkVersion}" // Without embedded AI model - around 20 MB smaller in size diff --git a/example/android/build.gradle b/example/android/build.gradle index 4f28d53..aa4e2c6 100644 --- a/example/android/build.gradle +++ b/example/android/build.gradle @@ -4,7 +4,7 @@ buildscript { minSdkVersion = 21 compileSdkVersion = 29 targetSdkVersion = 29 - yotiSdkVersion = "3.1.0" + yotiSdkVersion = "3.1.1" } repositories { google() diff --git a/example/ios/Demo/AppDelegate.h b/example/ios/Demo/AppDelegate.h index 2726d5e..ef1de86 100644 --- a/example/ios/Demo/AppDelegate.h +++ b/example/ios/Demo/AppDelegate.h @@ -1,10 +1,3 @@ -/** - * Copyright (c) Facebook, Inc. and its affiliates. - * - * This source code is licensed under the MIT license found in the - * LICENSE file in the root directory of this source tree. - */ - #import #import diff --git a/example/ios/Demo/AppDelegate.m b/example/ios/Demo/AppDelegate.m index 428ff22..959558a 100644 --- a/example/ios/Demo/AppDelegate.m +++ b/example/ios/Demo/AppDelegate.m @@ -1,10 +1,3 @@ -/** - * Copyright (c) Facebook, Inc. and its affiliates. - * - * This source code is licensed under the MIT license found in the - * LICENSE file in the root directory of this source tree. - */ - #import "AppDelegate.h" #import #import diff --git a/example/ios/Demo/main.m b/example/ios/Demo/main.m index 2acb707..a16d22c 100644 --- a/example/ios/Demo/main.m +++ b/example/ios/Demo/main.m @@ -1,10 +1,3 @@ -/** - * Copyright (c) Facebook, Inc. and its affiliates. - * - * This source code is licensed under the MIT license found in the - * LICENSE file in the root directory of this source tree. - */ - #import #import "AppDelegate.h"