Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
daniel-abramov authored and a-miyashita committed Jul 20, 2023
1 parent a41d736 commit 84dd23e
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,20 @@ Features
--------

Tungstenite provides a complete implementation of the WebSocket specification.
TLS is supported on all platforms using native-tls or rustls available through the `native-tls`
and `rustls-tls` feature flags. By default **no TLS feature is activated**, so make sure you
use `native-tls` or `rustls-tls` feature if you need support of the TLS.
TLS is supported on all platforms using `native-tls` or `rustls`. The following
features are available:

There is no support for permessage-deflate at the moment. It's planned.
* `native-tls`
* `native-tls-vendored`
* `rustls-tls-native-roots`
* `rustls-tls-webpki-roots`

Choose the one that is appropriate for your needs.

By default **no TLS feature is activated**, so make sure you use `native-tls` or
`rustls-tls` feature if you need support of the TLS.

There is no support for permessage-deflate at the moment, but the PRs are welcome :wink:

Testing
-------
Expand Down

0 comments on commit 84dd23e

Please sign in to comment.