Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)


40 changes: 33 additions & 7 deletions kotlin/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<dependency>
<groupId>io.inji</groupId>
<artifactId>pixelpass</artifactId>
<version>0.8.0-RC1</version>
<groupId>io.inji</groupId>
<artifactId>pixelpass-aar</artifactId>
<version>1.0.0-alpha.1</version>
</dependency>
```

**JVM (JAR)**

```xml
<dependency>
<groupId>io.inji</groupId>
<artifactId>pixelpass-jar</artifactId>
<version>1.0.0-alpha.1</version>
</dependency>
```

## APIs

Expand Down
Loading