From 12147521f2fe1a5b5fcde76ca2a49dca060c9e09 Mon Sep 17 00:00:00 2001 From: Ivan Smirnov Date: Mon, 3 Jan 2022 14:25:25 +0300 Subject: [PATCH] Update the readme with the benchmark timings --- README.md | 29 +++++++++++++++++++++++++---- 1 file changed, 25 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 31a5763..906fd09 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,31 @@ VERY fast encoder/decoder for [QOI image format](https://qoiformat.org/), implem Quick summary: -- One of the fastest encoders/decoders out there. -- Compliant with the latest QOI format specification. -- Supports decoding from streams and encoding to streams. -- No unsafe code. +- One of the [fastest](https://github.com/aldanor/qoi-fast#benchmarks) + QOI encoders/decoders out there. +- Compliant with the latest QOI [format specification](). +- Zero unsafe code. +- Supports decoding from / encoding to `std::io` streams directly. +- Roundtrip-tested vs the reference C implementation; fuzz-tested. + +### Examples + +```rust +todo!(); +``` + +### Benchmarks + +Comparison to the reference C implementation +(as of [00e34217](https://github.com/phoboslab/qoi/commit/00e34217)), +benchmarks timings collected on Apple M1 (1782 images, 1187 MB total): + +``` +codec decode:ms encode:ms decode:mp/s encode:mp/s + +qoi-c 4408.43 5529.64 282.3 225.1 +qoi-fast 3202.04 4666.84 388.7 266.7 +``` ### License