aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCorey Richardson <corey@octayn.net>2016-05-02 14:39:11 +1000
committerCorey Richardson <corey@octayn.net>2016-05-02 14:39:11 +1000
commit0eeafb2eea2bb686bce1eaf02060dccbc2c14552 (patch)
treea0e51d1b49bee3fa2aa6072cc44183367ade60ab /README.md
parent77b7a0984f3f524900f739b72ae3bc77819193fa (diff)
downloadbyteorder-0eeafb2eea2bb686bce1eaf02060dccbc2c14552.tar.gz
Enable usage in no_std contexts
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index d92b434..5640f3e 100644
--- a/README.md
+++ b/README.md
@@ -47,3 +47,13 @@ let mut rdr = Cursor::new(vec![2, 5, 3, 0]);
assert_eq!(517, rdr.read_u16::<BigEndian>().unwrap());
assert_eq!(768, rdr.read_u16::<BigEndian>().unwrap());
```
+
+### `no_std` crates
+
+This crate has a feature, `std`, that is enabled by default. To use this crate
+in a `no_std` context, add the following to your `Cargo.toml`:
+
+```toml
+[dependencies]
+byteorder = { version = "0.5", default-features = false }
+```