Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README.md #50

Closed
kelson42 opened this issue Jul 21, 2023 · 3 comments · Fixed by #60
Closed

Improve README.md #50

kelson42 opened this issue Jul 21, 2023 · 3 comments · Fixed by #60
Assignees
Labels
enhancement New feature or request

Comments

@kelson42
Copy link
Contributor

It should better include:

  • A badge to latest CI run
  • An stub example how to use the library
@kelson42 kelson42 added the enhancement New feature or request label Jul 21, 2023
@kelson42 kelson42 added this to the 1.1.0 milestone Jul 21, 2023
@kelson42 kelson42 self-assigned this Jul 21, 2023
@kelson42
Copy link
Contributor Author

kelson42 commented Aug 1, 2023

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
Copy link
Member

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
Copy link
Collaborator

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants