Skip to content

Commit

Permalink
Update README for release
Browse files Browse the repository at this point in the history
  • Loading branch information
carllerche committed Dec 4, 2015
1 parent 5cbb93d commit 168fcb5
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,16 @@ Feedback can be posted on the [PR](https://github.com/carllerche/mio/pull/222).
**API documentation**

* [master](http://rustdoc.s3-website-us-east-1.amazonaws.com/mio/master/mio/)
* [v0.5](http://rustdoc.s3-website-us-east-1.amazonaws.com/mio/v0.5.x/mio/)
* [v0.4](http://rustdoc.s3-website-us-east-1.amazonaws.com/mio/v0.4.x/mio/)
* [v0.3](http://rustdoc.s3-website-us-east-1.amazonaws.com/mio/v0.3.x/mio/)

## Usage

To use `mio`, first add this to your `Cargo.toml`:

```toml
[dependencies]
mio = "0.4"
mio = "0.5"
```

Then, add this to your crate root:
Expand All @@ -52,8 +52,16 @@ or higher level libraries.

## Platforms

Currently, MIO fully supports Linux and OS X. The master branch has beta
support for Windows.
Currently supported platforms:

* Linux
* OS X
* Windows
* Android
* NetBSD

There are potentially others. If you find that Mio works on another
platform, submit a PR to update the list!

## Resources

Expand Down

0 comments on commit 168fcb5

Please sign in to comment.