Skip to content

Commit 83a9ad9

Browse files
committed
Update REDME and CHANGELOG with note saying regulaforensics repo is needed only for yoti-sdk-doc-scan
Related to DEP-571
1 parent 85413db commit 83a9ad9

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

CHANGELOG.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
All notable changes to this project will be documented in this file.
33
## [4.0.0] - 2025-03-11
44
### Changed
5-
- Document processing improvements. This introduces a small breaking change requiring replacing the
6-
"microblink" maven url with the "regulaforensics" one in your allProjects entry in your root build.gradle
7-
file (see README - Setup the SDK). You can also remove any "microblink"-related proguard rules you have.
5+
- Document processing improvements. This introduces a small breaking change for users of the
6+
`yoti-sdk-doc-scan` module, requiring replacing the "microblink" maven url with the "regulaforensics"
7+
one in your allProjects entry in your root build.gradle file (see README - Setup the SDK). You can
8+
also remove any "microblink"-related proguard rules you have.
89
- Addressed compatibility issues when building with Android Gradle Plugin 8+
910
- Various bug fixes and improvements
1011

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ We strongly recommend you to migrate your app to the new Androidx libraries: htt
3333

3434
## Setup the SDK
3535

36-
Make sure you have mavenCentral and regulaforensics repository added in your allProjects entry in your root build.gradle:
36+
Make sure you have the mavenCentral repository added in your allProjects entry in your root build.gradle file. If you are using the `yoti-sdk-doc-scan` module, you will also need to add the regulaforensics repository:
3737

3838
```groovy
3939
allprojects {
@@ -46,6 +46,9 @@ allprojects {
4646
...
4747
}
4848
```
49+
50+
Note: If instead you are using the `yoti-sdk-doc-scan-slim` module, you do not need to add the regulaforensics repository.
51+
4952
If you are still using Yoti SDK version `3.5.2` or below, please refer to [these instructions](https://github.com/getyoti/yoti-doc-scan-android/blob/v3.5.2/README.md#setup-the-sdk) instead, but keep in mind that support for older versions is not guaranteed and we highly recommend updating to the latest one as soon as possible.
5053

5154
The Yoti SDK is composed of multiple feature modules. Each feature is optional, but you must include at least one to use the SDK.

0 commit comments

Comments
 (0)