diff --git a/README.md b/README.md index 403fc4a..23d4ee7 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,12 @@ # pixelpass This repository will be used to host the source code, documentation, and other related files for the PixelPass project which is used to generate and decode VC data to and from QR. +## Available Libraries + +This library is available in Kotlin, Swift, and JavaScript, supporting Android, JVM, iOS, and Node platforms. + +- **Kotlin**: [Android (AAR) & JVM (JAR)](./kotlin/Readme.md) +- **JavaScript**: [Node.js & Web](./js/Readme.md) +- **Swift**: [iOS](https://github.com/inji/pixelpass-ios-swift) + + diff --git a/kotlin/Readme.md b/kotlin/Readme.md index a3f8bc5..8d6872e 100644 --- a/kotlin/Readme.md +++ b/kotlin/Readme.md @@ -9,22 +9,48 @@ ## Usage -Both Kotlin and Java packages are compiled from same Kotlin codebase. They are also deployed as aar and jar packages to maven. Below is how to use them. +The library is implemented in Kotlin and is compatible with both **Kotlin** and **Java** projects. It is published to Maven as two artifacts: -### Kotlin +* **`pixelpass-aar`** – Android library (AAR) +* **`pixelpass-jar`** – JVM library (JAR) -`implementation("io.inji:pixelpass:0.8.0-RC1")` +Choose the artifact that best fits your project. -### Java +### Gradle + +**Android (AAR)** + +```gradle +implementation("io.inji:pixelpass-aar:1.0.0-alpha.1") +``` + +**JVM (JAR)** + +```gradle +implementation("io.inji:pixelpass-jar:1.0.0-alpha.1") +``` + +### Maven + +**Android (AAR)** ```xml - io.inji - pixelpass - 0.8.0-RC1 + io.inji + pixelpass-aar + 1.0.0-alpha.1 ``` +**JVM (JAR)** + +```xml + + io.inji + pixelpass-jar + 1.0.0-alpha.1 + +``` ## APIs