fleshed out roadmap, fixes #27

Author: illegalprime

ROADMAP.md

@@ -1,5 +1,30 @@
+# The Roadmap
 
-### Adding Features
+## More Docs, Examples and Tests
+
+Easy as that, every method should be tested and documented.
+Every use-case should have an example.
+
+## Adding Features
+
+### `net2` Feature
+
+This is a feature to add the `net2` crate which will let us do cool things
+like set the option `SO_REUSEADDR` and similar when making TCP connections.
+
+This is discussed in [vi/rust-websocket#2](https://github.com/vi/rust-websocket/pull/2).
+
+### Add Mio & Tokio (Evented Websocket)
+
+There are a lot of issues that would be solved if this was evented, such as:
+
+ - [#88 tokio support](https://github.com/cyderize/rust-websocket/issues/88)
+ - [#66 Timeout on recv_message](https://github.com/cyderize/rust-websocket/issues/66)
+ - [#6  one client, one thread?](https://github.com/cyderize/rust-websocket/issues/6)
+
+So maybe we should _just_ add `tokio` support, or maybe `mio` is still used and popular.
+
+### Support Permessage-Deflate
+
+We need this to pass more autobahn tests!
 
- - Make the usage of `net2` a feature
- - Make evented

src/stream.rs

@@ -1,6 +1,4 @@
 //! Provides the default stream type for WebSocket connections.
-// TODO: add mio support & tokio
-// extern crate mio;
 
 use std::ops::Deref;
 use std::io::{