aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAndrew Gallant <jamslam@gmail.com>2016-12-30 12:12:22 -0500
committerAndrew Gallant <jamslam@gmail.com>2016-12-30 12:12:22 -0500
commit1ee962d0ac501f96d77c90061549a64ecb07f96a (patch)
tree412ac4bfdfe39413019570850dac6004da1fe002 /README.md
parentd0df2d0dba2ef7a42d2c97c1975d8c6410f3a16c (diff)
downloadbyteorder-1ee962d0ac501f96d77c90061549a64ecb07f96a.tar.gz
Prepare for 1.0, switch to docs.rs.
Fixes #57
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 6 insertions, 9 deletions
diff --git a/README.md b/README.md
index 5640f3e..298a99d 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,5 @@
This crate provides convenience methods for encoding and decoding numbers in
-either big-endian or little-endian order. This is meant to replace the old
-methods defined on the standard library `Reader` and `Writer` traits.
+either big-endian or little-endian order.
[![Build status](https://api.travis-ci.org/BurntSushi/byteorder.png)](https://travis-ci.org/BurntSushi/byteorder)
[![](http://meritbadge.herokuapp.com/byteorder)](https://crates.io/crates/byteorder)
@@ -10,20 +9,18 @@ Dual-licensed under MIT or the [UNLICENSE](http://unlicense.org).
### Documentation
-[http://burntsushi.net/rustdoc/byteorder/](http://burntsushi.net/rustdoc/byteorder/).
-
-The documentation includes examples.
+https://docs.rs/byteorder
### Installation
This crate works with Cargo and is on
-[crates.io](https://crates.io/crates/byteorder). The package is regularly
-updated. Add it to your `Cargo.toml` like so:
+[crates.io](https://crates.io/crates/byteorder). Add it to your `Cargo.toml`
+like so:
```toml
[dependencies]
-byteorder = "0.5"
+byteorder = "1"
```
If you want to augment existing `Read` and `Write` traits, then import the
@@ -55,5 +52,5 @@ in a `no_std` context, add the following to your `Cargo.toml`:
```toml
[dependencies]
-byteorder = { version = "0.5", default-features = false }
+byteorder = { version = "1", default-features = false }
```