Skip to content

Commit

Permalink
mention zstd binary in the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
KillingSpark committed Mar 15, 2023
1 parent b8c447e commit d7351b4
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit d7351b4

Please sign in to comment.