Skip to content

Update Readme #891

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
atouchet wants to merge 1 commit into
base: master
Choose a base branch
from
+14 −14
Open

Update Readme #891

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@

A Tokio aware, HTTP/2 client & server implementation for Rust.

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![Crates.io](https://img.shields.io/crates/v/h2.svg)](https://crates.io/crates/h2)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/license/mit)
[![crates.io](https://img.shields.io/crates/v/h2.svg)](https://crates.io/crates/h2)
[![Documentation](https://docs.rs/h2/badge.svg)][dox]

More information about this crate can be found in the [crate documentation][dox].
More information about this crate can be found in the
[crate documentation][dox].

[dox]: https://docs.rs/h2

Expand All @@ -16,19 +17,20 @@ More information about this crate can be found in the [crate documentation][dox]
* Implements the full HTTP/2 specification.
* Passes [h2spec](https://github.com/summerwind/h2spec).
* Focus on performance and correctness.
* Built on [Tokio](https://tokio.rs).
* Built on [Tokio](https://tokio.rs/).

## Non goals
## Non-goals

This crate is intended to only be an implementation of the HTTP/2
specification. It does not handle:
This crate is intended to only be an implementation of the HTTP/2 specification.
It does not handle:

* Managing TCP connections
* HTTP 1.0 upgrade
* TLS
* Managing TCP connections.
* HTTP 1.0 upgrade.
* TLS.
* Any feature not described by the HTTP/2 specification.

This crate is now used by [hyper](https://github.com/hyperium/hyper), which will provide all of these features.
This crate is now used by [hyper](https://github.com/hyperium/hyper), which will
provide all of these features.

## Usage

Expand All @@ -42,8 +44,6 @@ h2 = "0.4"
Next, add this to your crate:

```rust
extern crate h2;

use h2::server::Connection;

fn main() {
Expand All @@ -55,4 +55,4 @@ fn main() {

**Is this an embedded Java SQL database engine?**

[No](https://www.h2database.com).
[No](https://www.h2database.com/).
Loading