Skip to content

Commit 0b118d8

Browse files
committed
Bumps version
1 parent d27b15b commit 0b118d8

File tree

2 files changed

+20
-7
lines changed

2 files changed

+20
-7
lines changed

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ members = [
1414
]
1515

1616
[workspace.package]
17-
version = "1.0.3"
17+
version = "1.1.0"
1818
authors = ["Swim Inc. developers [email protected]"]
1919
edition = "2021"
2020
categories = ["network-programming", "asynchronous", "web-programming::websocket"]

README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,37 @@
22
<br><br><br>
33

44
# Ratchet
5-
Ratchet is a fast, robust, lightweight and fully asynchronous implementation of [RFC6455](https://datatracker.ietf.org/doc/html/rfc6455) (The WebSocket protocol). Complete with an optional implementation of [RFC7692](https://datatracker.ietf.org/doc/html/rfc7692) (Compression Extensions For WebSocket).
65

7-
Ratchet powers [SwimOS on Rust](https://github.com/swimos/swim-rust/); a framework for real-time streaming data applications.
6+
Ratchet is a fast, robust, lightweight and fully asynchronous implementation
7+
of [RFC6455](https://datatracker.ietf.org/doc/html/rfc6455) (The WebSocket protocol). Complete with an optional
8+
implementation of [RFC7692](https://datatracker.ietf.org/doc/html/rfc7692) (Compression Extensions For WebSocket).
9+
10+
Ratchet powers [SwimOS on Rust](https://github.com/swimos/swim-rust/); a framework for real-time streaming data
11+
applications.
812

913
[![Crates.io][crates-badge]][crates-url]
1014

1115
[crates-badge]: https://img.shields.io/crates/v/ratchet_rs.svg
16+
1217
[crates-url]: https://crates.io/crates/ratchet_rs
1318

1419
[Documentation](https://docs.rs/ratchet_rs/latest/ratchet_rs/)
1520

16-
1721
# Features
22+
1823
- Implement your own extensions using [ratchet_ext](/ratchet_ext).
1924
- Per-message deflate with [ratchet_deflate](/ratchet_deflate) or enable with the `deflate`
2025
feature.
2126
- Split WebSocket with the `split` feature.
2227

2328
# Testing
29+
2430
Ratchet is fully tested and passes every Autobahn test for both client and server modes.
2531

2632
# Examples
33+
2734
## Client
35+
2836
```rust
2937
#[tokio::main]
3038
async fn main() -> Result<(), Error> {
@@ -37,7 +45,7 @@ async fn main() -> Result<(), Error> {
3745
)
3846
.await?;
3947

40-
let UpgradedClient{ socket, subprotocol }=upgraded;
48+
let UpgradedClient { socket, subprotocol } = upgraded;
4149
let mut buf = BytesMut::new();
4250

4351
loop {
@@ -60,6 +68,7 @@ async fn main() -> Result<(), Error> {
6068
```
6169

6270
## Server
71+
6372
```rust
6473
#[tokio::main]
6574
async fn main() -> Result<(), Error> {
@@ -74,7 +83,7 @@ async fn main() -> Result<(), Error> {
7483
socket,
7584
WebSocketConfig::default(),
7685
NoExtProvider,
77-
ProtocolRegistry::default(),
86+
SubprotocolRegistry::default(),
7887
)
7988
.await?;
8089

@@ -115,18 +124,21 @@ async fn main() -> Result<(), Error> {
115124
Ok(())
116125
}
117126
```
127+
118128
## Deflate
129+
119130
```rust
120131
let mut websocket = ratchet::accept_with(
121132
socket,
122133
WebSocketConfig::default(),
123134
DeflateProvider,
124-
ProtocolRegistry::default(),
135+
SubprotocolRegistry::default(),
125136
)
126137
.await?;
127138
```
128139

129140
## Split
141+
130142
```rust
131143
// A split operation will only fail if the WebSocket is already closed.
132144
let (mut sender, mut receiver) = websocket.split()?;
@@ -148,4 +160,5 @@ loop {
148160
```
149161

150162
# License
163+
151164
Ratchet is licensed under the [Apache License 2.0](LICENSE)

0 commit comments

Comments
 (0)