feat: safe websocket client implementation
This commit is contained in:
20
README.md
20
README.md
@@ -1,2 +1,22 @@
|
||||
# safe-web-socket
|
||||
|
||||
> A secure, production-ready WebSocket wrapper for Go with built-in validation, rate limiting, authentication, and connection management.
|
||||
|
||||
## Overview
|
||||
|
||||
`SafeWebSocket` is a Go library designed to simplify the creation of **secure, scalable, and resilient WebSocket servers**. Built on top of `gorilla/websocket`, it adds essential safety layers — including authentication, input validation, connection limits, rate limiting, and graceful shutdown — so you can focus on your application logic, not security pitfalls.
|
||||
|
||||
Whether you’re building real-time dashboards, chat apps, or live data feeds, `SafeWebSocket` ensures your WebSocket endpoints are protected against common attacks (e.g., DoS, injection, unauthorized access).
|
||||
|
||||
## Features
|
||||
- ✅ **Graceful Shutdown & Cleanup**
|
||||
- ✅ **Automatic Reconnection Handling (Client-side helpers)**
|
||||
- ✅ **WebSocket Ping/Pong Health Checks**
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
go get git.neurocipta.com/rogerferdinan/safe-web-socket
|
||||
```
|
||||
|
||||
> Requires Go 1.24+
|
||||
Reference in New Issue
Block a user