12 Commits

Author SHA1 Message Date
MohitMaliFtechiz
3b103f6718 Updated the README file to show the required Java version to compile the project. 2024-06-26 11:19:05 +05:30
Emmanuel Engelhart
8f58782027
Add badge for the continuous deployment 2024-02-05 18:51:27 +01:00
MohitMali
ee1f2b4ff0
Added instructions in README.md file to show how devs can use latest binaries in their project. 2023-08-27 11:28:44 +07:00
MohitMali
27d70f7376 Moved java-libkiwix to new Maven repo.
* We are moving our `java-libkiwix` to the new maven repo `org.kiwix` with version code `1.0.0`.
* Updated `README.md` file to use updated badge.
2023-08-16 17:57:04 +05:30
MohitMali
190473fdcb Update README with additional instructions for loading ZIM files and articles.
This commit updates the README file to include additional instructions for loading ZIM files and accessing articles in the Kiwix content archive using the `java-libkiwix` library.

Changes made in the README:
- Added a section explaining how to load a ZIM file by creating an `Archive` object.
- Clarified the description of the `mainPage` property, detailing its behavior when dealing with redirects and non-existent entries.
- Provided code snippets and instructions for loading articles via title and path, including a reminder to properly decode the URL path before passing it to `hasEntryByPath`.

These changes aim to improve the documentation and assist developers in effectively utilizing the `java-kibkiwix` library to work with zim files.
2023-08-11 14:56:32 +05:30
Kelson
7ac4541a69 Update README.md
Small improvements of the README file
2023-07-28 15:23:43 +02:00
MohitMali
ebd27b53f1 Fixed libkiwix dependency
* Updated the source of libkiwix and libzim .so files to download.kiwix.org/release instead of using nightly builds.
* Introduced new variables for specifying the versions of libkiwix and libzim, allowing retrieval of .so files from the release repositories.
* Modified the README.md file to get the version and image from maven central for `org.kiwix.libkiwix` artifact.
2023-07-19 11:20:47 +05:30
MohitMaliFtechiz
3fd6a01f0f Renamed generateHeader as buildHeader and buildLinuxSoFile as buildLinuxBinding for better naming 2023-05-20 17:07:23 +02:00
MohitMaliFtechiz
78c57aa361 Renamed generateHeaderFilesFromJavaWrapper method to generateHeaders for better readability 2023-05-20 17:05:18 +02:00
Matthieu Gautier
7de75101fb Adapt README.md and change build.sh into install_deps.sh 2022-12-21 16:01:02 +01:00
Emmanuel Engelhart
7bc3239924
Fix Maven badge URL 2022-09-12 10:23:13 +02:00
Emmanuel Engelhart
95bede99ce
First version of README 2022-09-10 16:37:34 +02:00