Skip to content

Commit 4ed32d1

Browse files
committed
docs(README): update readme for 0.11 resources
1 parent c4c60d9 commit 4ed32d1

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# hyper
1+
# [hyper](https://hyper.rs)
22

33
[![Travis Build Status](https://travis-ci.org/hyperium/hyper.svg?branch=master)](https://travis-ci.org/hyperium/hyper)
44
[![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.
1010

1111
### Documentation
1212

13-
- [Released](http://hyperium.github.io/hyper)
13+
- [Released](http://docs.rs/hyper)
1414
- [Master](http://hyperium.github.io/hyper/master)
1515

16+
Get started by looking over the [guides](https://hyper.rs/guides).
17+
1618
## Overview
1719

1820
hyper is a fast, modern HTTP implementation written in and for Rust. It
1921
is a low-level typesafe abstraction over raw HTTP, providing an elegant
2022
layer over "stringly-typed" HTTP.
2123

22-
Hyper offers both an HTTP client and server which can be used to drive
24+
hyper offers both an HTTP client and server which can be used to drive
2325
complex web applications written entirely in Rust.
2426

25-
Be aware that hyper is still actively evolving towards 1.0, and is likely
26-
to experience breaking changes before stabilising. The current area of
27-
change is the movement towards async IO and refining the design around
28-
that. You can also see the [1.0 issue milestone](https://github.com/hyperium/hyper/milestone/1).
27+
hyper makes use of "async IO" (non-blocking sockets) via the [Tokio](https://tokio.rs) and [Futures](https://docs.rs/futures) libraries.
2928

30-
The documentation is located at [http://hyperium.github.io/hyper](http://hyperium.github.io/hyper).
29+
See the [Hello World](https://github.com/hyperium/hyper/blob/master/examples/hello.rs) example for a toy server using hyper.
30+
31+
Be aware that hyper is still actively evolving towards 1.0, and is likely
32+
to experience breaking changes before stabilising. You can also see the [1.0 issue milestone](https://github.com/hyperium/hyper/milestone/1).

0 commit comments

Comments
 (0)