From 07b2514737f5ab498536725c62124792289aeff9 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Sat, 22 Jul 2017 23:40:45 +0200 Subject: [PATCH] readme: deserializer/decoder actually accepts `&[u8]`, not `Vec` --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cda12a2..cd0a13a 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,9 @@ A compact encoder / decoder pair that uses a binary zero-fluff encoding scheme. The size of the encoded object will be the same or smaller than the size that the object takes up in memory in a running Rust program. -In addition to exposing two simple functions that encode to Vec and decode -from Vec, binary-encode exposes a Reader/Writer API that makes it work +In addition to exposing two simple functions +(one that encodes to `Vec`, and one that decodes from `&[u8]`), +binary-encode exposes a Reader/Writer API that makes it work perfectly with other stream-based apis such as rust files, network streams, and the [flate2-rs](https://github.com/alexcrichton/flate2-rs) compression library.