# perfect-ws documentation

Start with the [README](../README.md) to install PerfectWS and make your first request.

For practical examples, use [Common use cases](common-use-cases.md). It covers async handlers, application errors, progress, callbacks, cancellation, binary data, a remote file writer, middleware, and cleanup.

Open the other guides only when you need that feature:

- [Authentication](authentication.md) - credentials, rate limiting, reconnect options, lifecycle hooks, and reverse connections
- [Browser clients](browser.md) - native browser WebSockets connected to a Node server
- [Middleware and routing](middleware-and-routing.md) - validation, shared middleware, and route groups
- [Reconnection and streaming](reconnection-and-streaming.md) - keeping active streams alive across a reconnect
- [Serialization and transforms](serialization-and-transforms.md) - callbacks, binary/native types, circular data, and custom classes
- [PureRPC](pure-rpc.md) - live remote objects, trust requirements, reconnects, and automatic cleanup
- [Production and resilience](production-resilience.md) - limits, timeouts, pings, reconnects, and ACK tuning
- [API reference](api-reference.md) - core signatures and configuration options