forked/hyper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(README): emphasize getting started with the Guides

Browse Source 
Closes #1265
This commit is contained in:
Sean McArthur
2017-09-16 16:24:46 -07:00
parent c97ff990c4
commit 0a23420c15
1 changed files with 7 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -6,27 +6,25 @@
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE) [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
[![crates.io](http://meritbadge.herokuapp.com/hyper)](https://crates.io/crates/hyper) [![crates.io](http://meritbadge.herokuapp.com/hyper)](https://crates.io/crates/hyper)
A Modern HTTP library for Rust. A low-level HTTP implementation for Rust.
### Documentation ### Documentation
- [Released](http://docs.rs/hyper) - [Released](http://docs.rs/hyper)
- [Master](http://hyperium.github.io/hyper/master) - [Master](http://hyperium.github.io/hyper/master)
Get started by looking over the [guides](https://hyper.rs/guides). **Get started** by looking over the [guides](https://hyper.rs/guides).
## Overview ## Overview
hyper is a fast, modern HTTP implementation written in and for Rust. It hyper is a fast, safe HTTP implementation written in and for Rust.
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. 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) libraries. hyper makes use of "async IO" (non-blocking sockets) via the
[Tokio](https://tokio.rs) and [Futures](https://docs.rs/futures) crates.
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 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). to experience breaking changes before stabilising. You can also see the
[1.0 issue milestone](https://github.com/hyperium/hyper/milestone/1).