You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-5Lines changed: 18 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,12 +9,25 @@ This repository contains a Rust implementation of the zlib file format that is c
9
9
10
10
This repository contains two public crates:
11
11
12
-
*`zlib-rs`, a Rust implementation based on [zlib](https://www.zlib.net/manual.html)
13
-
with a safe rust API
14
-
*`libz-rs-sys`, a zlib-compatible C API for usage in non-Rust
15
-
applications
12
+
*[zlib-rs](https://crates.io/crates/zlib-rs/), a Rust implementation based on [zlib](https://www.zlib.net/manual.html)
13
+
with a safe rust API. This API is under development and still unstable.
14
+
*[libz-rs-sys](https://crates.io/crates/libz-rs-sys/), a zlib-compatible C API for usage in non-Rust
15
+
applications.
16
16
17
-
## Acknowledgement
17
+
## How to use zlib-rs in your project
18
+
19
+
zlib-rs can be used in both Rust and C projects.
20
+
21
+
### Rust projects
22
+
23
+
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`
24
+
backend.
25
+
26
+
## C projects
27
+
28
+
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).
29
+
30
+
## Acknowledgment
18
31
19
32
This project is heavily based on the [zlib](https://github.com/madler/zlib) and
0 commit comments