# warcat-rs
Command-line tool and Rust library for handling Web ARChive (WARC) files.
This project is a rewrite of the [warcat](https://github.com/chfoo/warcat/) project.
## Getting started
* [💿 Downloads](https://github.com/chfoo/warcat-rs/releases)
* [📖 User guide 
](https://warcat-rs.readthedocs.io/)
* [📦 Crate repository 
](https://crates.io/crates/warcat)
* [📑 API documentation 
](https://docs.rs/warcat)
## Compiling
If you want to compile the program yourself, set up a [Rust environment](https://www.rust-lang.org/tools/install).
* Project requires Rust 1.80 or higher.
Once you have Rust installed, use the cargo build tool:
```sh
cargo build --features=bin --release
```
The program will be placed in the `target` directory.
## Contributing & support
* [Contributing](https://github.com/chfoo/warcat-rs/blob/main/.github/CONTRIBUTING.md)
* [Support](https://github.com/chfoo/warcat-rs/blob/main/.github/SUPPORT.md)
* [Changelog](https://github.com/chfoo/warcat-rs/blob/main/CHANGELOG.md)
* [Development roadmap](https://github.com/chfoo/warcat-rs/blob/main/roadmap.md)
## License
Copyright 2024 Christopher Foo. Licensed under Mozilla Public License 2.0