Skip to content

chore: update README.md #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shellrow merged 1 commit into from
Jul 25, 2026
Merged

chore: update README.md #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 1 addition & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@

A minimal WebSocket library for native and WebAssembly.

The minimum supported Rust version (MSRV) is 1.88.

## Workspace crates

- `websock`: top-level facade that selects native (`websock-tungstenite`) or browser (`websock-wasm`) transport.
Expand All @@ -26,7 +24,7 @@ The minimum supported Rust version (MSRV) is 1.88.

```toml
[dependencies]
websock = "0.4"
websock = "0.5"
```

API documentation is available on [docs.rs][doc-url].
Expand Down Expand Up @@ -64,14 +62,6 @@ inconsistent limits return a protocol error rather than panicking.
The multiplexing wire format, stream lifecycle, flow control, compatibility
policy, and error codes are specified in [docs/mux-protocol.md](docs/mux-protocol.md).

## Error handling

Native I/O failures retain their original `std::io::Error`, including the
`ErrorKind`, in `websock_proto::Error::Io`. TLS and underlying WebSocket
transport failures retain their concrete errors as standard error sources.
Call `std::error::Error::source` to inspect or downcast those sources, and use
`Error::io_kind` when only the I/O classification is needed.

## Benchmarking

Criterion benchmarks are available for `websock-mux-proto`.
Expand Down
Loading