Update documentation

onfido · Nov 28, 2019 · 47cfeaf · 47cfeaf
1 parent 4ccf299
commit 47cfeaf
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 3 deletions.
diff --git a/CHANGELOG.MD b/CHANGELOG.MD
@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 **Note**: If the strings translations change it will result in a MINOR version change, therefore you are responsible for testing your translated layout in case you are using custom translations. [More on language localisation](README.md#4-localisation)
 
+## [5.3.0]
+
+### Added:
+- Public: `DocumentType.GENERIC` type added. For more information, please visit our [README.md](README.md#document-capture-step) 
+
+### Changed:
+- UI: Liveness intro video accessibility string improved
+
 ## [5.2.0]
 
 ### Added:

diff --git a/MIGRATION.md b/MIGRATION.md
@@ -1,5 +1,14 @@
 # Onfido Android SDK Migration Guide
 
+
+## `5.2.0` -> `5.3.0`
+
+### Added strings:
+- `onfido_label_doc_type_generic_up`
+
+### Changed Strings:
+- `onfido_accessibility_liveness_video_example`
+
 ## `5.1.0` -> `5.2.0`
 
 ### Added strings:
@@ -26,7 +35,6 @@
 ### Changed
 - No longer obfuscating `com.monadtek.mvp` package
 
-
 ## `4.11.0` -> `5.0.0`
 
 ### Applicant removal and Token change

diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Onfido Android SDK
 
 [![Download](https://api.bintray.com/packages/onfido/maven/onfido-capture-sdk/images/download.svg)](https://bintray.com/onfido/maven/onfido-capture-sdk/_latestVersion)
-
+![Build Status](https://app.bitrise.io/app/0d3fe90349e46fbe/status.svg?token=6GpMhK-XJU_9kWRuHzkLmA&branch=master)
 
 ## Table of contents
 
@@ -314,6 +314,18 @@ By replacing this step with a `CaptureScreenStep`, you are allowed to specify a
 - Specify an actual country, using the `CountryCode` enum, e.g. `new CaptureScreenStep(DocumentType.NATIONAL_IDENTITY_CARD, CountryCode.GB)`
 - Specify that no country should be used, with the `CountryAlternatives.NO_COUNTRY` option, e.g. `new CaptureScreenStep(DocumentType.NATIONAL_IDENTITY_CARD, CountryAlternatives.NO_COUNTRY)`
 
+The supported document types are:
+
+- Passport: `DocumentType.PASSPORT`
+- National Identity Card: `DocumentType.NATIONAL_IDENTITY_CARD`
+- Driving Licence: `DocumentType.DRIVING_LICENCE`
+- Residence Permit: `DocumentType.RESIDENCE_PERMIT`
+- Visa: `DocumentType.VISA`
+- Work Permit: `DocumentType.WORK_PERMIT`
+- Generic: `DocumentType.GENERIC`
+
+**Note** `DocumentType.GENERIC` doesn't offer an optimised capture experience for a desired document type. 
+
 Please be aware that we don't support every document - country combination, and unsupported documents will not be verified. So if you decide to bypass the default country selection screen by replacing the `FlowStep.CAPTURE_DOCUMENT` with a `CaptureScreenStep`, please make sure that you are specifying a supported document.
 We provide an up-to-date list of the documents we support [here](https://onfido.com/supported-documents/)
 

diff --git a/strings.xml b/strings.xml
@@ -205,7 +205,7 @@
     <string name="onfido_back">Back</string>
 
     <!-- Accessibility strings for screen readers -->
-    <string name="onfido_accessibility_liveness_video_example">Example video showing how to record a selfie video</string>
+    <string name="onfido_accessibility_liveness_video_example">To record a selfie video, face the front camera and keep your phone slightly away from your face. You'll then need to recite some numbers and turn your head according to the instructions on screen</string>
     <string name="onfido_accessibility_camera_document_capture_view">View from camera</string>
     <string name="onfido_accessibility_camera_face_capture_view">View from selfie camera</string>
     <string name="onfido_accessibility_face_confirmation_view">Photo of your face</string>