Skip to content

Commit 29a8342

Browse files
authored
Don't be so humble in README (#509)
1 parent 6cf5bd9 commit 29a8342

File tree

1 file changed

+6
-11
lines changed

1 file changed

+6
-11
lines changed

README.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,17 @@
44
[![Crates.io](https://img.shields.io/crates/v/png.svg)](https://crates.io/crates/png)
55
[![License](https://img.shields.io/crates/l/png.svg)](https://github.com/image-rs/image-png)
66

7-
PNG decoder/encoder in pure Rust.
7+
Robust and performant PNG decoder/encoder in pure Rust. Also supports [APNG](https://en.wikipedia.org/wiki/APNG).
88

9-
It contains all features required to handle the entirety of [the PngSuite by
10-
Willem van Schack][PngSuite].
9+
No `unsafe` code, battle-tested, and fuzzed on [OSS-fuzz](https://github.com/google/oss-fuzz).
1110

12-
[PngSuite]: http://www.schaik.com/pngsuite2011/pngsuite.html
11+
## Performance
1312

14-
## pngcheck
13+
Performance is typically on par with or better than libpng.
1514

16-
The `pngcheck` utility is a small demonstration binary that checks and prints
17-
metadata on every `.png` image provided via parameter. You can run it (for
18-
example on the test directories) with
15+
Includes an fast encoding mode powered by [fdeflate](https://crates.io/crates/fdeflate) that is dramatically faster than the fastest mode of libpng while *simultaneously* providing better compression ratio.
1916

20-
```bash
21-
cargo run --release --example pngcheck ./tests/pngsuite/*
22-
```
17+
On nightly Rust compiler you can slightly speed up decoding of certain images as well as encoding even further by enabling the `unstable` feature of this crate.
2318

2419
## License
2520

0 commit comments

Comments
 (0)