Skip to content

Commit

Permalink
add section on using; change spelling to US
Browse files Browse the repository at this point in the history
  • Loading branch information
squell authored and folkertdev committed Nov 13, 2024
1 parent bb204f5 commit db8c732
Showing 1 changed file with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,25 @@ This repository contains a Rust implementation of the zlib file format that is c

This repository contains two public crates:

* `zlib-rs`, a Rust implementation based on [zlib](https://www.zlib.net/manual.html)
with a safe rust API
* `libz-rs-sys`, a zlib-compatible C API for usage in non-Rust
applications
* [zlib-rs](https://crates.io/crates/zlib-rs/), a Rust implementation based on [zlib](https://www.zlib.net/manual.html)
with a safe rust API. This API is under development and still unstable.
* [libz-rs-sys](https://crates.io/crates/libz-rs-sys/), a zlib-compatible C API for usage in non-Rust
applications.

## Acknowledgement
## How to use zlib-rs in your project

zlib-rs can be used in both Rust and C projects.

### Rust projects

By far the easiest way to use zlib-rs is through the [flate2](https://crates.io/crates/flate2) crate, by simply enabling the `zlib-rs` feature gate. This will enable the `zlib-rs`
backend.

## C projects

zlib-rs can be built as a shared object file for usage by C programs that dynamically link to zlib. Please see the example in [libz-rs-sys-cdylib](https://github.com/trifectatechfoundation/zlib-rs/tree/main/libz-rs-sys-cdylib).

## Acknowledgment

This project is heavily based on the [zlib](https://github.com/madler/zlib) and
[zlib-ng](https://github.com/zlib-ng/zlib-ng) projects.
Expand Down

0 comments on commit db8c732

Please sign in to comment.