Skip to content

Commit 38d0465

Browse files
authored
Update Readme (#369)
1 parent 35d110c commit 38d0465

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
Asynchronous WebSockets for Tokio stack.
44

5-
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
6-
[![Crates.io](https://img.shields.io/crates/v/tokio-tungstenite.svg?maxAge=2592000)](https://crates.io/crates/tokio-tungstenite)
7-
[![Build Status](https://travis-ci.org/snapview/tokio-tungstenite.svg?branch=master)](https://travis-ci.org/snapview/tokio-tungstenite)
5+
[![MIT Licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
6+
[![crates.io](https://img.shields.io/crates/v/tokio-tungstenite.svg?maxAge=2592000)](https://crates.io/crates/tokio-tungstenite)
7+
[![Build Status](https://github.com/snapview/tokio-tungstenite/actions/workflows/ci.yml/badge.svg)](https://github.com/snapview/tokio-tungstenite/actions)
88

99
[Documentation](https://docs.rs/tokio-tungstenite)
1010

@@ -14,7 +14,7 @@ Add this in your `Cargo.toml`:
1414

1515
```toml
1616
[dependencies]
17-
tokio-tungstenite = "*"
17+
tokio-tungstenite = "0.28"
1818
```
1919

2020
Take a look at the `examples/` directory for client and server examples. You may also want to get familiar with
@@ -27,7 +27,7 @@ can use it with non-blocking/asynchronous `TcpStream`s from and couple it togeth
2727

2828
## Features
2929

30-
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 feature flags: `native-tls`, `rustls-tls-native-roots` or `rustls-tls-webpki-roots` feature flags. Neither is enabled by default. See the `Cargo.toml` for more information. If you require support for secure WebSockets (`wss://`) enable one of them.
30+
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/rustls/rustls) through feature flags: `native-tls`, `rustls-tls-native-roots` or `rustls-tls-webpki-roots` feature flags. Neither is enabled by default. See the `Cargo.toml` for more information. If you require support for secure WebSockets (`wss://`) enable one of them.
3131

3232
Note, that if you're using `rustls` features with `tokio-tungstenite` [version `0.23.0`](https://github.com/snapview/tokio-tungstenite/blob/master/CHANGELOG.md#0230) or higher,
3333
you [might observe a panic](https://github.com/snapview/tokio-tungstenite/issues/336) that is easy to fix (see the issue). Check [the discussion](https://github.com/snapview/tokio-tungstenite/issues/353#issuecomment-2455100010)

0 commit comments

Comments
 (0)