Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Onfido Android Team committed Aug 27, 2020
1 parent 78aa5a4 commit d43ef25
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 14 deletions.
10 changes: 10 additions & 0 deletions CHANGELOG.MD
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,16 @@ 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)

## [7.3.0] - 2020-08-27

### Added

- Public: Added config to enable manual liveness capture

### Changed

- UI: Removed Singapore endonym

## [7.2.0] - 06.07.2020

### Changed:
Expand Down
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,8 @@ Average size (with Proguard enabled):

| ABI | Size |
| ----------- | :-----: |
| armeabi-v7a | 6.29 Mb |
| arm64-v8a | 7.33 Mb |
| armeabi-v7a | 6.31 Mb |
| arm64-v8a | 7.34 Mb |

#### 2.2 `onfido-capture-sdk-core`
Lighter, app size-friendly version. This version provides a set of basic image validations mostly provided by the backend.
Expand All @@ -127,7 +127,7 @@ Average size (with Proguard enabled):

| ABI | Size |
| ----------- | :-----: |
| universal | 3.84 Mb |
| universal | 3.86 Mb |

The sizes stated above were measured by building the minimum possible wrappers around our SDK,
using the following [stack](https://github.com/bitrise-io/bitrise.io/blob/master/system_reports/linux-docker-android-lts.log).
Expand Down Expand Up @@ -360,15 +360,15 @@ In this step the user can pick which type of document to capture, the document o

To customise a document capture step you can use `DocumentCaptureStepBuilder` class's functions for the corresponding document types.

| Document Type | Configuration function| Configurable Properties |
|-----------------------|-----------------------|----------------------------|
| Passport | forPassport() | |
| National Identity Card| forNationalIdentity() | - country<br> - documentFormat |
| Driving Licence | forDrivingLicence() | - country<br> - documentFormat |
| Residence Permit | forDrivingLicence() | - country |
| Visa | forVisa() | - country |
| Work Permit | forWorkPermit() | - country |
| Generic | forGenericDocument() | - country |
| Document Type | Configuration function | Configurable Properties |
| ----------------------- | ----------------------- | ---------------------------- |
| Passport | forPassport() | |
| National Identity Card | forNationalIdentity() | - country<br> - documentFormat |
| Driving Licence | forDrivingLicence() | - country<br> - documentFormat |
| Residence Permit | forDrivingLicence() | - country |
| Visa | forVisa() | - country |
| Work Permit | forWorkPermit() | - country |
| Generic | forGenericDocument() | - country |

**Note** `GENERIC` document type doesn't offer an optimised capture experience for a desired document type.

Expand Down Expand Up @@ -481,8 +481,6 @@ Onfido Android SDK already comes with out-of-the-box translations for the follow
- French (fr) :fr:
- German (de) :de:

In case you would like us to add translations for some other locales we don't provide yet, please contact us through [[email protected]](mailto:[email protected]).

You could also provide custom translations for locales that we don't currently support, by having an additional XML strings file inside your resources folder for the desired locale (e.g. `res/values-it/onfido_strings.xml` for :it: translation), with the content of our [strings.xml](strings.xml) file, translated for that locale.

By default, we infer the language to use from the device settings.
Expand Down Expand Up @@ -609,6 +607,8 @@ The Onfido Android SDK has been optimised to provide the following accessibility
- Sufficient color contrast: default colors have been tested to meet the recommended level of contrast
- Sufficient touch target size: all interactive elements have been designed to meet the recommended touch target size

Refer to our [accessibility statement](https://developers.onfido.com/guide/sdk-accessibility-statement) for more details.

## Getting notified about releases

In case you want to get notified about our releases, feel free to access our [Bintray page](https://bintray.com/onfido/maven/onfido-capture-sdk) and click the `Watch` button.
Expand Down

0 comments on commit d43ef25

Please sign in to comment.