From 4380e425877c6358b36066357d8bf045dfd50058 Mon Sep 17 00:00:00 2001
From: Alex Crichton <alex@alexcrichton.com>
Date: Fri, 5 Aug 2016 16:21:56 -0700
Subject: [PATCH] More info and more READMEs

---
 README.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 63 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 000000000..41b8d5aa0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,63 @@
+# futures-mio
+
+Build status, license, and other information can be found in the top-level
+[README.md].
+
+[README.md]: https://github.com/alexcrichton/futures-rs#futures-rs
+
+[Documentation](http://alexcrichton.com/futures-rs/futures_mio)
+
+## Usage
+
+First, add this to your `Cargo.toml`:
+
+```toml
+[dependencies]
+futures-mio = { git = "https://github.com/alexcrichton/futures-rs" }
+```
+
+Next, add this to your crate:
+
+```rust
+extern crate futures_mio;
+```
+
+## Examples
+
+There are a few small examples showing off how to use this library:
+
+* [echo.rs] - a simple TCP echo server
+* [socks5.rs] - an implementation of a SOCKSv5 proxy server
+
+[echo]: https://github.com/alexcrichton/futures-rs/blob/master/futures-mio/src/bin/echo.rs
+[socks5.rs]: https://github.com/alexcrichton/futures-rs/blob/master/futures-socks5/src/main.rs
+
+## What is futures-mio?
+
+This crate is a connection `futures`, a zero-cost implementation of futures in
+Rust, and `mio`, a crate for zero-cost asynchronous I/O, and `futures-io`,
+abstractions for I/O on top of the `futures` crate. The types and structures
+implemented in `futures-mio` implement `Future` and `Stream` traits as
+appropriate. For example connecting a TCP stream returns a `Future` resolving
+to a TCP stream, and a TCP listener implements a stream of TCP streams
+(accepted connections).
+
+This crate also provides facilities such as:
+
+* TCP streams
+* TCP listeners
+* UDP sockets
+* Timeouts
+* Data owned and local to the event loop
+* An `Executor` implementation for a futures' `Task`
+
+The intention of `futures-mio` is to provide a concrete implementation for
+crates built on top of `futures-io`. For example you can easily turn a TCP
+stream into a TLS/SSL stream with the [`futures-tls`] crate or use the
+combinators to compose working with data on sockets.
+
+[`futures-tls`]: http://alexcrichton.com/futures-rs/futures_tls
+
+Check out the [documentation] for more information, and more coming here soon!
+
+[documentation]: http://alexcrichton.com/futures-rs/futures_mio