Skip to content

Commit

Permalink
Added instructions in README.md file to show how devs can use lates…
Browse files Browse the repository at this point in the history
…t binaries in their project.
  • Loading branch information
MohitMaliDeveloper authored and kelson42 committed Aug 27, 2023
1 parent 574fc63 commit 17a432f
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,30 @@ Library for accessing [libkiwix](https://github.com/kiwix/libkiwix) and [libzim]

AAR file will be generated in directory `lib/build/outputs/aar`

### Use the binary in your project

First, locate the `lib-debug.aar` file.
You can find it in the `lib/build/outputs/aar` directory.
Copy this file to a location on your computer. Open your project's Gradle configuration file.
Inside the Gradle file, import the AAR file as a dependency.
To do this, you need to specify the path to the AAR file.

If you are using Kotlin for your Gradle file, add the following code snippet:

```kotlin
dependencies {
implementation(files("path-of-aar-file/lib-debug.aar"))
}
```

If you are using Groovy for your Gradle file, use this code snippet:

```kotlin
dependencies {
implementation files("path-to-your-aar-file/lib-debug.aar")
}
```

### Load zim file

To load a ZIM file you need to create an `Archive` object.
Expand Down

0 comments on commit 17a432f

Please sign in to comment.