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

Updated README with additional instructions for loading ZIM files and articles #60

Merged
merged 1 commit into from
Aug 11, 2023

Commits on Aug 11, 2023

  1. 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.
    MohitMaliDeveloper committed Aug 11, 2023
    Configuration menu
    Copy the full SHA
    190473f View commit details
    Browse the repository at this point in the history