From 768808d892848f509057b267781cae6e8c62b790 Mon Sep 17 00:00:00 2001 From: MohitMali Date: Mon, 21 Aug 2023 18:45:05 +0530 Subject: [PATCH] Added instructions in `README.md` file to show how devs can use latest binaries in their project. --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 149481f..0ad0d2b 100644 --- a/README.md +++ b/README.md @@ -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.