From 793588edae63d10f8ca4bec8d5aacbb9ee2623e5 Mon Sep 17 00:00:00 2001
From: Ty Overby <ty@pre-alpha.com>
Date: Sat, 7 Feb 2015 19:03:17 -0800
Subject: [PATCH] update readme

---
 README.md     | 10 +++++-----
 readme.dev.md | 17 +++++++++++++++++
 2 files changed, 22 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 06dab1e..aba2576 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@ 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 functions that encode to Vec<u8> and decode
+In addition to exposing two simple funcitons that encode to Vec<u8> and decode
 from Vec<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
@@ -17,8 +17,6 @@ library.
 ## Example
 
 ```rust
-#![feature(old_orphan_check)]
-
 extern crate bincode;
 extern crate "rustc-serialize" as rustc_serialize;
 
@@ -41,9 +39,11 @@ fn main() {
     };
 
     let encoded: Vec<u8> = bincode::encode(&world, SizeLimit::Infinite).unwrap();
+
     // 8 bytes for the length of the vector, 4 bytes per float.
     assert_eq!(encoded.len(), 8 + 4 * 4);
-    let decoded: World = bincode::decode(encoded, SizeLimit::Infinite).unwrap();
+
+    let decoded: World = bincode::decode(&encoded[]).unwrap();
 
     assert!(world == decoded);
 }
@@ -61,7 +61,7 @@ then the contents.
 
 However, there are some implementation details to be aware of:
 
-* `int`/`uint` are encoded as `i64`/`u64`, for portability.
+* `isize`/`usize` are encoded as `i64`/`u64`, for portability.
 * enums variants are encoded as a `u32` instead that as a `uint`.
   `u32` is enough for all practical uses.
 * `str` is encoded as `(u64, &[u8])`, where the `u64` is the number of
diff --git a/readme.dev.md b/readme.dev.md
index 799042a..aff8a13 100644
--- a/readme.dev.md
+++ b/readme.dev.md
@@ -17,3 +17,20 @@ library.
 ## Example
 
 ^code(./examples/basic.rs)
+
+
+## Details
+
+The encoding (and thus decoding) proceeds unsurprisingly -- primitive
+types are encoded according to the underlying `Writer`, tuples and
+structs are encoded by encoding their fields one-by-one, and enums are
+encoded by first writing out the tag representing the variant and
+then the contents.
+
+However, there are some implementation details to be aware of:
+
+* `isize`/`usize` are encoded as `i64`/`u64`, for portability.
+* enums variants are encoded as a `u32` instead that as a `uint`.
+  `u32` is enough for all practical uses.
+* `str` is encoded as `(u64, &[u8])`, where the `u64` is the number of
+  bytes contained in the encoded string.