Update documentation

onfido · Oct 20, 2020 · 3681cef · 3681cef
1 parent d43ef25
commit 3681cef
Show file tree

Hide file tree

Showing 7 changed files with 618 additions and 195 deletions.
diff --git a/CHANGELOG.MD b/CHANGELOG.MD
@@ -7,17 +7,28 @@ 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.4.0] - 2020-10-20
+
+### Added
+
+- Public: Added support for South African ID folded paper document capture
+
+### Changed
+
+- Public: Renamed most of the localisation keys. Now, names are more explicit in which screens they are being used. Please visit our [MIGRATION.md](MIGRATION.md#730---740)
+- Public: Remove duplication in the README file
+
 ## [7.3.0] - 2020-08-27
 
 ### Added
 
-- Public: Added config to enable manual liveness capture
+- Public: Added config to enable manual liveness capture 
 
 ### Changed
 
 - UI: Removed Singapore endonym
 
-## [7.2.0] - 06.07.2020
+## [7.2.0] - 2020.07.06
 
 ### Changed:
 - Public: Improved US Driver Licence auto-capture performance
@@ -29,7 +40,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Removed:
 - Internal: Removed the zxing library dependency
 
-## [7.1.0] - 25.06.2020
+## [7.1.0] - 2020.06.25
 
 ### Added:
 - UI: Added co-branding feature - [enterprise]

diff --git a/MIGRATION.md b/MIGRATION.md
@@ -1,5 +1,17 @@
 # Onfido Android SDK Migration Guide
 
+## `7.3.0` -> `7.4.0`
+
+### Added Strings:
+- `onfido_app_title_doc_capture_id_za`
+
+### Changed Strings:
+- ⚠️ Most of the localisation keys have been renamed. If you have customised any of the Onfido SDK's strings in your project, you may use [migrate-keys.rb](key_migration/migrate-keys.rb) script and key mapping file [key_migration_7_3_0_mapping.json](key_migration/key_migration_7_3_0_mapping.json) to migrate from 7.3.0 to 7.4.0
+
+```bash
+  migrate-keys.rb --files-path <app/src/main/res/> --platform android --key-mapping-file key_migration_7_3_0_mapping.json
+```
+
 ## `7.0.0` -> `7.1.0`
 
 #### Deprecation

diff --git a/README.md b/README.md
@@ -106,8 +106,8 @@ Average size (with Proguard enabled):
 
 | ABI         |  Size   |
 | ----------- | :-----: |
-| armeabi-v7a | 6.31 Mb  |
-| arm64-v8a   | 7.34 Mb  |
+| armeabi-v7a | 6.32 Mb  |
+| arm64-v8a   | 7.36 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.
@@ -127,7 +127,7 @@ Average size (with Proguard enabled):
 
 | ABI         |  Size   |
 | ----------- | :-----: |
-| universal   | 3.86 Mb  |
+| universal   | 3.87 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).
@@ -187,8 +187,6 @@ We strongly recommend using a **SDK token**. It provides a more secure means of
 
 You will need to generate and include a short-lived JSON Web Token (JWT) every time you initialise the SDK. To generate an SDK Token you should perform a request to the SDK Token endpoint in the Onfido API:
 
-To generate an SDK Token you should perform a request to the SDK Token endpoint in the Onfido API:
-
 ```
 $ curl https://api.onfido.com/v3/sdk_token \
   -H 'Authorization: Token token=YOUR_API_TOKEN' \
@@ -400,7 +398,7 @@ val drivingLicenceCaptureStep = DocumentCaptureStepBuilder.forDrivingLicence()
 
 This configuration allows you to specify format of document such as ***Card*** and ***Folded***
 
-**Note**: You can specify ***folded*** document format for only French driving licence and Italian national identity. If you would configure the SDK with unsupported
+**Note**: You can specify ***folded*** document format for only French driving licence, South African national identity and Italian national identity. If you would configure the SDK with unsupported
 country configuration the SDK will throw `InvalidDocumentFormatAndCountryCombinationException`   
 
 If you would like to specify country and document format for driving license