Improve README.md - Githubissues

kiwix / java-libkiwix

Libkiwix binding for Java & Kotlin

https://central.sonatype.com/artifact/org.kiwix/libkiwix

GNU General Public License v3.0

3 stars 4 forks source link

Improve README.md #50

Closed kelson42 closed 1 year ago

kelson42 commented 1 year ago

It should better include:

A badge to latest CI run
An stub example how to use the library

kelson42 commented 1 year ago

Mostly done with #55

@MohitMaliDeveloper Can you please put a simple example in Kotlin how to load a zim file and an article? i have also a question: can this lib be used in a normal java program on linux?

mgautierfr commented 1 year ago

can this lib be used in a normal java program on linux?

Not tested, but I would say mostly.

The only dependency to android is in : https://github.com/kiwix/java-libkiwix/blob/main/lib/src/main/java/org/kiwix/libkiwix/JNIKiwix.java

But we may have to fix few small things before having a truly java library (compilation, ...)

MohitMaliFtechiz commented 1 year ago

@MohitMaliDeveloper Can you please put a simple example in Kotlin how to load a zim file and an article?

I have made these changes in #60.