Skip to content

Commit

Permalink
Add documentation about TLS features to README
Browse files Browse the repository at this point in the history
  • Loading branch information
torlenor committed Apr 17, 2021
1 parent 287f477 commit c9b886e
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Expand Up @@ -24,3 +24,7 @@ Take a look at the `examples/` directory for client and server examples. You may

This crate is based on [`tungstenite-rs`](https://github.com/snapview/tungstenite-rs) Rust WebSocket library and provides `Tokio` bindings and wrappers for it, so you
can use it with non-blocking/asynchronous `TcpStream`s from and couple it together with other crates from `Tokio` stack.

## Features

As with [`tungstenite-rs`](https://github.com/snapview/tungstenite-rs) TLS is supported on all platforms using [`native-tls`](https://github.com/sfackler/rust-native-tls) or [`rustls`](https://github.com/ctz/rustls) through the `native-tls` and `rustls-tls` feature flags. Neither is enabled by default. If you require support for secure WebSockets (`wss://`) enable one of them.

0 comments on commit c9b886e

Please sign in to comment.