diff --git a/README.md b/README.md index 2da7c874..711d24a3 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,48 @@ [![Build Status](https://travis-ci.org/hyperium/hyper.svg?branch=master)](https://travis-ci.org/hyperium/hyper) -An HTTP library for Rust. +A Modern HTTP library for Rust. [Documentation](http://hyperium.github.io/hyper) -## Scientific* Benchmarks +## Overview -[Client bench:](./benches/client.rs) +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/S client an HTTP server which can be used to drive +complex web applications written entirely in Rust. + +The documentation is located at [http://hyperium.github.io/hyper](http://hyperium.github.io/hyper). + +## Scientific\* Benchmarks + +[Client Bench:](./benches/client.rs) + +``` + +running 3 tests +test bench_curl ... bench: 1696689 ns/iter (+/- 540497) +test bench_http ... bench: 2222778 ns/iter (+/- 1159060) +test bench_hyper ... bench: 1435613 ns/iter (+/- 359384) + +test result: ok. 0 passed; 0 failed; 0 ignored; 3 measured +``` + +[Mock Client Bench:](./benches/client_mock_tcp.rs) + +``` +running 3 tests +test bench_mock_curl ... bench: 329240 ns/iter (+/- 50413) +test bench_mock_http ... bench: 61291 ns/iter (+/- 19253) +test bench_mock_hyper ... bench: 54458 ns/iter (+/- 15792) + +test result: ok. 0 passed; 0 failed; 0 ignored; 3 measured +``` + + +[Server Bench:](./benches/server.rs) ``` running 3 tests @@ -19,7 +54,8 @@ test bench_hyper ... bench: 224482 ns/iter (+/- 95197) test result: ok. 0 passed; 0 failed; 0 ignored; 3 measured ``` -_* No science was harmed in this benchmark._ +\* No science was harmed in the making of this benchmark. + ## License