Skip to content

Commit 6cffcd4

Browse files
authored
Update README.md
1 parent 7bccb3e commit 6cffcd4

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44

55
The project contains a sample application that uses Microblink's [BlinkID SDK](https://github.com/BlinkID/blinkid-android) to scan an ID card. The app uses [Ver-ID SDK](https://github.com/AppliedRecognition/Ver-ID-UI-Android) to detect a face on the captured ID card and compare it to a live selfie taken with the Android device's camera.
66

7+
## Before you build the app
8+
9+
1. Create a new project in [Google Firebase console](https://console.firebase.google.com) and add an Android app with package name `com.appliedrec.credentials.app`.
10+
1. Download the **google-services.json** file generated by Firebase and add it to the project's **app** folder.
11+
712
## Adding Ver-ID to your Android Studio project
813

914
1. [Request an API secret](https://dev.ver-id.com/admin/register) for your app.
@@ -27,6 +32,44 @@ The project contains a sample application that uses Microblink's [BlinkID SDK](h
2732
android:name="com.appliedrec.verid.apiSecret"
2833
android:value="[your API secret]" />
2934
~~~
35+
36+
37+
1. [Register your app](https://dev.ver-id.com/licensing/). You will need your app's package name.
38+
2. Registering your app will generate an evaluation licence for your app. The licence is valid for 30 days. If you need a production licence please [contact Applied Recognition](mailto:sales@appliedrec.com).
39+
2. When you finish the registration you'll receive a file called **Ver-ID identity.p12** and a password. Copy the password to a secure location.
40+
3. Copy the **Ver-ID identity.p12** into your app's assets folder. A common location is **your\_app_module/src/main/assets**.
41+
8. Ver-ID will need the password you received at registration.
42+
- You can either specify the password when you create an instance of `VerIDFactory`:
43+
44+
~~~java
45+
VerIDFactory veridFactory = new VerIDFactory(this, "your password goes here");
46+
~~~
47+
- Or you can add the password in your app's **AndroidManifest.xml**:
48+
49+
~~~xml
50+
<manifest>
51+
<application>
52+
<meta-data
53+
android:name="com.appliedrec.verid.password"
54+
android:value="your password goes here" />
55+
</application>
56+
</manifest>
57+
~~~
58+
59+
1. Add the Applied Recognition repository and Ver-ID dependencies to your app module's **gradle.build** file:
60+
61+
~~~groovy
62+
repositories {
63+
maven {
64+
url 'https://dev.ver-id.com/artifactory/gradle-release'
65+
}
66+
}
67+
68+
dependencies {
69+
implementation 'com.appliedrec.verid:rx:[1.7,2.0['
70+
implementation 'com.appliedrec.verid:ui:[1.16,2.0['
71+
}
72+
~~~
3073
3174
## Adding Microblink to your Android Studio project
3275

0 commit comments

Comments
 (0)