Skip to content

Commit 2d84a14

Browse files
authored
update readme
1 parent f90649d commit 2d84a14

1 file changed

Lines changed: 9 additions & 6 deletions

File tree

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
# EasyDocumentScan: Compose Multiplatform Document Scanner
22

33
[![CI Status](https://img.shields.io/github/actions/workflow/status/kalinjul/EasyDocumentScan/main.yml)]((https://github.com/kalinjul/EasyDocumentScan/actions/workflows/main.yml))
4-
[![Maven Central](https://img.shields.io/maven-central/v/io.github.kalinjul.easydocumentscan/documentscanner)](https://repo1.maven.org/maven2/io/github/kalinjul/easydocumentscan/documentscanner/)
5-
[![Snapshot](https://img.shields.io/nexus/s/io.github.kalinjul.easydocumentscan/documentscanner?server=https%3A%2F%2Fs01.oss.sonatype.org&label=latest%20snapshot)](https://s01.oss.sonatype.org/content/repositories/snapshots/io/github/kalinjul/easydocumentscan/documentscanner/)
6-
![Kotlin Version](https://kotlin-version.aws.icerock.dev/kotlin-version?group=io.github.kalinjul.easydocumentscan&name=documentscanner)
4+
[![Maven Central](https://img.shields.io/maven-central/v/io.github.kalinjul.easydocumentscan/documentscanner-compose)](https://repo1.maven.org/maven2/io/github/kalinjul/easydocumentscan/documentscanner-compose/)
5+
![Kotlin Version](https://kotlin-version.aws.icerock.dev/kotlin-version?group=io.github.kalinjul.easydocumentscan&name=documentscanner-compose)
76
![Compose Version](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fkalinjul%2FEasyDocumentScan%2Fmain%2Fgradle%2Flibs.versions.toml&query=%24.versions%5B'compose-multiplatform'%5D&label=Compose%20Version)
87

98
Document Scanner for Compose Multiplatform (Android/iOS) using [VNDocumentCameraViewController](https://developer.apple.com/documentation/visionkit/vndocumentcameraviewcontroller) on iOS and [MLKit Document scanner](https://developers.google.com/ml-kit/vision/doc-scanner) on Android.
@@ -17,17 +16,21 @@ Supported Compose version:
1716
| 1.9 | 0.3.0+ |
1817

1918
# Dependency
19+
> [!NOTE]
20+
> Artifact id changed from "documentscanner" to "documentscanner-compose" and a new "documentscanner-core" artifact was introduced with 0.3.2 that contains the KmpFile abstraction as well as some Helper functions.
21+
2022
Add the dependency to your commonMain sourceSet (KMP) / Android dependencies (android only):
2123
```kotlin
22-
implementation("io.github.kalinjul.easydocumentscan:documentscanner:0.3.1")
24+
implementation("io.github.kalinjul.easydocumentscan:documentscanner-compose:0.3.2")
2325
```
2426

2527
Or, for your libs.versions.toml:
2628
```toml
2729
[versions]
28-
easydocumentscan = "0.3.1"
30+
easydocumentscanner = "0.3.2"
2931
[libraries]
30-
easydocumentscan = { module = "io.github.kalinjul.easydocumentscan:documentscanner-compose", version.ref = "easydocumentscan" }
32+
easydocumentscanner-compose = { module = "io.github.kalinjul.easydocumentscan:documentscanner-compose", version.ref = "easydocumentscanner" }
33+
easydocumentscanner-core = { module = "io.github.kalinjul.easydocumentscan:documentscanner-core", version.ref = "easydocumentscanner" }
3134
```
3235

3336
# Usage

0 commit comments

Comments
 (0)