diff --git a/README.md b/README.md index 6d0928e3..3d8ccd10 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# hyper +# [hyper](https://hyper.rs) [![Travis Build Status](https://travis-ci.org/hyperium/hyper.svg?branch=master)](https://travis-ci.org/hyperium/hyper) [![Appveyor Build status](https://ci.appveyor.com/api/projects/status/tb0n55fjs5tohdfo/branch/master?svg=true)](https://ci.appveyor.com/project/seanmonstar/hyper) @@ -10,21 +10,23 @@ A Modern HTTP library for Rust. ### Documentation -- [Released](http://hyperium.github.io/hyper) +- [Released](http://docs.rs/hyper) - [Master](http://hyperium.github.io/hyper/master) +Get started by looking over the [guides](https://hyper.rs/guides). + ## Overview hyper is a fast, modern HTTP implementation written in and for Rust. It is a low-level typesafe abstraction over raw HTTP, providing an elegant layer over "stringly-typed" HTTP. -Hyper offers both an HTTP client and server which can be used to drive +hyper offers both an HTTP client and server which can be used to drive complex web applications written entirely in Rust. -Be aware that hyper is still actively evolving towards 1.0, and is likely -to experience breaking changes before stabilising. The current area of -change is the movement towards async IO and refining the design around -that. You can also see the [1.0 issue milestone](https://github.com/hyperium/hyper/milestone/1). +hyper makes use of "async IO" (non-blocking sockets) via the [Tokio](https://tokio.rs) and [Futures](https://docs.rs/futures) libraries. -The documentation is located at [http://hyperium.github.io/hyper](http://hyperium.github.io/hyper). +See the [Hello World](https://github.com/hyperium/hyper/blob/master/examples/hello.rs) example for a toy server using hyper. + +Be aware that hyper is still actively evolving towards 1.0, and is likely +to experience breaking changes before stabilising. You can also see the [1.0 issue milestone](https://github.com/hyperium/hyper/milestone/1).