diff --git a/README.md b/README.md index db64ec9..e4a2874 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,22 @@ +Libkiwix binding for Java/Kotlin +================================ + +Library for accessing [libkiwix](https://github.com/kiwix/libkiwix) and [libzim](https://github.com/openzim/libzim/) with Java or Kotlin on Android. + [![Maven Central](https://img.shields.io/maven-central/v/org.kiwix.libkiwix/libkiwix)](https://search.maven.org/artifact/org.kiwix.libkiwix/libkiwix) +[![Build Status](https://github.com/kiwix/java-libkiwix/workflows/CI/badge.svg?query=branch%3Amain)](https://github.com/kiwix/java-libkiwix/actions?query=workflow%3ACI+branch%3Amain) [![CodeFactor](https://www.codefactor.io/repository/github/kiwix/java-libkiwix/badge)](https://www.codefactor.io/repository/github/kiwix/java-libkiwix) +[![Codecov](https://codecov.io/gh/kiwix/java-libkiwix/branch/main/graph/badge.svg)](https://codecov.io/gh/kiwix/java-libkiwix) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) -# Java Libkiwix binding for Java/Kotlin - -Android Library for accessing libkiwix and libzim in android with JAVA wrapper. - -# Steps to build - -## Clone java-libkiwix - -```bash -git clone https://github.com/kiwix/java-libkiwix.git -cd java-libkiwix -``` +# Build ## Install dependencies - ```bash ./install_deps.sh ``` ## Compile - - ```bash ./gradlew buildHeaders ./gradlew build @@ -32,5 +25,11 @@ cd java-libkiwix AAR file will be generated in directory `lib/build/outputs/aar` +# License + +[GPLv3](https://www.gnu.org/licenses/gpl-3.0) or later, see +[COPYING](COPYING) for more details. + +