Skip to content

Commit acfe4ba

Browse files
docs: improve description of the project
1 parent 0ac940e commit acfe4ba

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,29 @@
11
# @socket.io/bun-engine
22

3+
A highly efficient, Bun-powered engine for Socket.IO, designed to enhance real-time communication performance.
4+
5+
This package provides a custom engine for Socket.IO that leverages the speed and scalability of Bun to handle WebSocket
6+
connections seamlessly.
7+
8+
Reference: https://socket.io/
9+
10+
**Table of contents**
11+
12+
<!-- TOC -->
13+
* [How to use](#how-to-use)
14+
* [Options](#options)
15+
* [`path`](#path)
16+
* [`pingTimeout`](#pingtimeout)
17+
* [`pingInterval`](#pinginterval)
18+
* [`upgradeTimeout`](#upgradetimeout)
19+
* [`maxHttpBufferSize`](#maxhttpbuffersize)
20+
* [`allowRequest`](#allowrequest)
21+
* [`cors`](#cors)
22+
* [`editHandshakeHeaders`](#edithandshakeheaders)
23+
* [`editResponseHeaders`](#editresponseheaders)
24+
* [License](#license)
25+
<!-- TOC -->
26+
327
## How to use
428

529
```js

0 commit comments

Comments
 (0)