docs(lib): rewrite hyper overview

This commit is contained in:
Sean McArthur
2019-12-09 11:50:53 -08:00
parent 78e8da17cf
commit 5b48ec0fe5
2 changed files with 27 additions and 25 deletions

View File

@@ -7,32 +7,23 @@
A **fast** and **correct** HTTP implementation for Rust.
- HTTP/1 and HTTP/2
- Asynchronous design
- Leading in performance
- Tested and **correct**
- Extensive production use
- Client and Server APIs
**Get started** by looking over the [guides](https://hyper.rs/guides).
**Hyper is a relatively low-level library, if you are looking for simple
high-level HTTP client, then you may wish to consider
## "Low-level"
hyper is a relatively low-level library, meant to be a building block for
libraries and applications.
Ff you are looking for a convenient HTTP client, then you may wish to consider
[reqwest](https://github.com/seanmonstar/reqwest), which is built on top of
this library.**
*NOTE*: hyper's [master](https://github.com/hyperium/hyper) branch is currently
preparing breaking changes, for most recently released code, look to the
[0.12.x](https://github.com/hyperium/hyper/tree/0.12.x) branch.
## Overview
hyper is a fast, safe HTTP implementation written in and for Rust.
hyper offers both an HTTP client and server which can be used to drive
complex web applications written entirely in Rust.
hyper makes use of "async IO" (non-blocking sockets) via the
[Tokio](https://tokio.rs) and [Futures](https://docs.rs/futures) crates.
Be aware that hyper is still actively evolving towards 1.0, and is likely
to experience breaking changes before stabilising. However, this mostly now
around the instability of `Future` and `async`. The rest of the API is rather
stable now. You can also see the
[issues in the upcoming milestones](https://github.com/hyperium/hyper/milestones).
this library.
## Contributing

View File

@@ -9,12 +9,23 @@
//!
//! hyper is a **fast** and **correct** HTTP implementation written in and for Rust.
//!
//! hyper provides both a [Client](client/index.html) and a
//! [Server](server/index.html).
//! ## Features
//!
//! - HTTP/1 and HTTP/2
//! - Asynchronous design
//! - Leading in performance
//! - Tested and **correct**
//! - Extensive production use
//! - [Client](client/index.html) and [Server](server/index.html) APIs
//!
//! If just starting out, **check out the [Guides](https://hyper.rs/guides)
//! first.**
//!
//! ## "Low-level"
//!
//! hyper is a lower-level HTTP library, meant to be a building block
//! for libaries and applications.
//!
//! If looking for just a convenient HTTP client, consider the
//! [reqwest](https://crates.io/crates/reqwest) crate.
//!