From c03e05dbba39f69172a6ffa1332876f54c15a430 Mon Sep 17 00:00:00 2001
From: Daniel Abramov <dabramov@snapview.de>
Date: Fri, 26 May 2017 12:17:21 +0200
Subject: [PATCH] Add README.md to the repository

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b4a2af1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# tokio-tungstenite
+
+Asynchronous WebSockets for Tokio stack.
+
+[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
+[![Crates.io](https://img.shields.io/crates/v/tokio-tungstenite.svg?maxAge=2592000)](https://crates.io/crates/tokio-tungstenite)
+
+[Documentation](https://docs.rs/tokio-tungstenite)
+
+## Usage
+
+First, you need to add this in your `Cargo.toml`:
+
+```toml
+[dependencies]
+tokio-timer = "*"
+```
+
+Next, add this to your crate:
+
+```rust
+extern crate tokio_tungstenite;
+```
+
+Take a loot at the `examples/` directory for client and server examples. You may also want to get familiar with
+[tokio](https://tokio.rs/) if you don't have any experience with it.
+
+## What is tokio-tungstenite?
+
+This crate is based on `tungstenite-rs` Rust WebSocket library and provides `tokio` bindings and wrappers for it, so you
+can use it with non-blocking/asynchronous `TcpStream`s from and couple it together with other crates from `tokio` stack.