From d7351b4fecd319e2bf2d713ebb3aef9032e43510 Mon Sep 17 00:00:00 2001 From: Moritz Borcherding Date: Wed, 15 Mar 2023 20:31:09 +0100 Subject: [PATCH] mention zstd binary in the readme --- Readme.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Readme.md b/Readme.md index 41f48c92..1a6edee9 100644 --- a/Readme.md +++ b/Readme.md @@ -24,6 +24,7 @@ Measuring with the 'time' utility the original zstd and my decoder both decoding 1. Decode all of them correctly into the output buffer 1. Decode all the decode_corpus files (1000+) I created locally 1. Calculate checksums +1. Act as a `zstd -c -d` dropin replacement ## Cannot do @@ -61,6 +62,8 @@ This will tell you where the decoder panics exactly. If you are able to fix the # How can you use it? +Additionally to the descriptions and the docs you can have a look at the zstd / zstd_streaming binaries. They showcase how this library can be used. + ## Easy The easiest is to wrap the io::Read into a StreamingDecoder which itself implements io::Read. It will decode blocks as necessary to fulfill the read requests