summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorCarl Lerche <me@carllerche.com>2018-02-07 13:28:29 -0800
committerGitHub <noreply@github.com>2018-02-07 13:28:29 -0800
commit23bc9d20d315d904918817b05bc043dca68b3da3 (patch)
tree0bc97636de4b265cca8e1f4099742f2a6df821ae /README.md
parentc225b46b187bf364143dd71b0f027c2eaf0cb66b (diff)
Prepare for tokio 0.1 release (#119)
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 14 insertions, 10 deletions
diff --git a/README.md b/README.md
index e8d28140..619244c3 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,24 @@
-# tokio
+# Tokio
-A work-in-progress rearchitecting of the [tokio-core] crate in line with
-[tokio-rs/tokio-rfcs#3][rfc]
-
-[tokio-core]: https://github.com/tokio-rs/tokio-core
-[rfc]: https://github.com/tokio-rs/tokio-rfcs/pull/3
+A platform for writing fast networking code with Rust.
[![Build Status](https://travis-ci.org/tokio-rs/tokio.svg?branch=new-crate)](https://travis-ci.org/tokio-rs/tokio)
[![Build status](https://ci.appveyor.com/api/projects/status/uxiinkgipvy6ehrj/branch/new-crate?svg=true)](https://ci.appveyor.com/project/alexcrichton/tokio/branch/new-crate)
-[Documentation](https://tokio-rs.github.io/tokio/tokio)
+[Website](https://tokio.rs) |
+[Guides](https://tokio.rs/docs/getting-started/hello-world/) |
+[API Docs](https://docs.rs/tokio)
+
+## Overview
+
+Tokio is an event-driven, non-blocking I/O platform for writing asynchronous I/O
+backed applications. It is used for implementing networking clients and servers.
-## Usage
+Tokio uses the [`futures`] crate as a foundation to build on, providing
+networking types and other utilities needed for building a production ready
+application.
-This project is a **work in progress**, more information will be added here as
-it progresses.
+[`futures`]: https://github.com/rust-lang-nursery/futures-rs
# License