micropelago/tokio-rustls
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clarify and expand documentation.

Browse Source 
Fix the license badges to point to the correct files. Fix some typos.
Add more links. Explain how to run the examples.
This commit is contained in:
Brian Smith 2017-03-29 17:58:30 -10:00
parent 2a5640459b
commit 2bf0ba169f
2 changed files with 30 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -1,11 +1,10 @@
# tokio-rustls # tokio-rustls
[![crates](https://img.shields.io/crates/v/tokio-rustls.svg)](https://crates.io/crates/tokio-rustls) [![crates](https://img.shields.io/crates/v/tokio-rustls.svg)](https://crates.io/crates/tokio-rustls) [![license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/quininer/tokio-rustls/blob/master/LICENSE-MIT) [![license](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/quininer/tokio-rustls/blob/master/LICENSE-APACHE) [![docs.rs](https://docs.rs/tokio-rustls/badge.svg)](https://docs.rs/tokio-rustls/)
[![license](https://img.shields.io/github/license/quininer/tokio-rustls.svg)](https://github.com/quininer/tokio-rustls/blob/master/LICENSE)
[![docs.rs](https://docs.rs/tokio-rustls/badge.svg)](https://docs.rs/tokio-rustls/)
[tokio-tls](https://github.com/tokio-rs/tokio-tls) fork, use [rustls](https://github.com/ctz/rustls). Asynchronous TLS/SSL streams for [Tokio](https://tokio.rs/) using
[Rustls](https://github.com/ctz/rustls).
### exmaple ### Basic Structure of a Client
```rust ```rust
// ... // ...
@ -22,3 +21,27 @@ TcpStream::connect(&addr, &handle)
// ... // ...
``` ```
### Client Example Program
See [examples/client.rs](examples/client.rs). You can run it with:
```sh
cargo run --example client google.com
```
### Server Example Program
See [examples/server.rs](examples/server.rs). You can run it with:
```sh
cargo run --example server -- 127.0.0.1 --cert mycert.der --key mykey.der
```
### License & Origin
tokio-rustls is primarily distributed under the terms of both the [MIT license](LICENSE-MIT) and
the [Apache License (Version 2.0)](LICENSE-APACHE), with portions covered by various BSD-like
licenses.
This started as a fork of [tokio-tls](https://github.com/tokio-rs/tokio-tls).

5
src/lib.rs
View File

@ -1,6 +1,5 @@
//! Async TLS streams //! Asynchronous TLS/SSL streams for Tokio using [Rustls](https://github.com/ctz/rustls).
//!
//! [tokio-tls](https://github.com/tokio-rs/tokio-tls) fork, use [rustls](https://github.com/ctz/rustls).
#[cfg_attr(feature = "tokio-proto", macro_use)] extern crate futures; #[cfg_attr(feature = "tokio-proto", macro_use)] extern crate futures;
extern crate tokio_io; extern crate tokio_io;