search-engine-stract/crates/zimba
Mikkel Denker 01de7a107b
Improve zimba+web-spell docs and release the modules under MIT (#242)
* improve web-spell docs

* improve zimba docs

* release zimba + web-spell under MIT
2024-12-02 13:21:26 +01:00
..
src Improve zimba+web-spell docs and release the modules under MIT (#242) 2024-12-02 13:21:26 +01:00
Cargo.toml use nom in zimba parser (#236) 2024-11-20 10:12:52 +01:00
LICENSE Improve zimba+web-spell docs and release the modules under MIT (#242) 2024-12-02 13:21:26 +01:00
README.md Improve zimba+web-spell docs and release the modules under MIT (#242) 2024-12-02 13:21:26 +01:00

Zimba

Zimba is a parser for the Zim file format written in pure Rust. Zim files are commonly used e.g. by wikipedia to distribute dumps of their articles for offline usage. Zimba only intends to support reading of Zim files, not writing.

Usage

use zimba::{ZimFile, Error};

fn main() -> Result<(), Error> {
    let zim_file = ZimFile::open("path/to/file.zim")?;

    for article in zim_file.articles()? {
        println!("{}", article.title);
    }

    Ok(())
}

License

Zimba is licensed under the MIT license. See the LICENSE file for details.