Skip to content

Commit 4b535ca

Browse files
committed
Mention rust backend & update miniz and flate info
Note that there is now a rust back-end. Point the miniz link to the new github page instead of the removed google code one. Mention that the flate library is no longer part of the rust compiler, and fix the link so it doesn't point to the wrong library. (the libflate library on crates.io is a different library.)
1 parent 7f01a9f commit 4b535ca

File tree

2 files changed

+18
-6
lines changed

2 files changed

+18
-6
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,13 @@
66
[![Documentation](https://docs.rs/flate2/badge.svg)](https://docs.rs/flate2)
77

88
A streaming compression/decompression library for Rust. The underlying
9-
implementation by default uses [`miniz`](https://code.google.com/p/miniz/) but
9+
implementation by default uses [`miniz`](https://github.com/richgel999/miniz) but
1010
can optionally be configured to use the system zlib, if available.
1111

12+
There is also an experimental rust backend that uses the
13+
[`miniz_oxide`](https://crates.io/crates/miniz_oxide) crate. This avoids the need
14+
to build C code, but hasn't gone through as much testing as the other backends.
15+
1216
Supported formats:
1317

1418
* deflate
@@ -28,6 +32,13 @@ Using zlib instead of miniz:
2832
flate2 = { version = "0.2", features = ["zlib"], default-features = false }
2933
```
3034

35+
Using the rust back-end:
36+
37+
```toml
38+
[dependencies]
39+
flate2 = { version = "0.2", features = ["rust_backend"], default-features = false }
40+
```
41+
3142
## Compression
3243

3344
```rust

src/lib.rs

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
//! A DEFLATE-based stream compression/decompression library
22
//!
3-
//! This library is meant to supplement/replace the standard distributon's
4-
//! libflate library by providing a streaming encoder/decoder rather than purely
3+
//! This library is meant to supplement/replace the
4+
//! `flate` library that was previously part of the standard rust distribution
5+
//! providing a streaming encoder/decoder rather than purely
56
//! an in-memory encoder/decoder.
67
//!
7-
//! Like with [`libflate`], flate2 is based on [`miniz.c`][1]
8+
//! Like with [`flate`], flate2 is based on [`miniz.c`][1]
89
//!
9-
//! [1]: https://code.google.com/p/miniz/
10-
//! [`libflate`]: https://docs.rs/crate/libflate/
10+
//! [1]: https://github.com/richgel999/miniz
11+
//! [`flate`]: https://github.com/rust-lang/rust/tree/1.19.0/src/libflate
1112
//!
1213
//! # Organization
1314
//!

0 commit comments

Comments
 (0)