From a8edf6cdfd0b834033bbd659f2c34abbec850c7e Mon Sep 17 00:00:00 2001 From: Ty Date: Sat, 11 Oct 2014 12:47:18 -0700 Subject: [PATCH] Update readme.md --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 32590a8..4dc59df 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,12 @@ A compact encoder / decoder pair that uses an 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 funcitons that encode to `Vec` and decode +from `Vec`, 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. + [Api Documentation](http://tyoverby.github.io/binary-encode/binary_encode/) ## Example