Skip to content

Commit af705a6

Browse files
authored
chore: update readme
1 parent 115e534 commit af705a6

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77

88
<!-- [![Codecov][codecov-src]][codecov-href] -->
99

10-
> [!WIP]
11-
> This project and API is under heavy development and opened to test integrations. Don't rely on it for production yet. Feedbacks welcome about API design!
10+
> [!WARNING]
11+
> This project and API are under heavy development and trial. Please don't rely on it for production yet. Feedback is more than welcome!
1212
13-
Cross-platform WebSocket server adapters:
13+
Cross-platform WebSocket Servers:
1414

15-
- Elegant, typed and simple interface to define WebSocket handlers
16-
- Performant per-server handlers instead of per-connection events api ([why](https://bun.sh/docs/api/websockets#lcYFjkFYJC-summary))
15+
- Elegant, typed, and simple interface to define your WebSocket server handlers
16+
- Performant per-server handlers instead of per-connection events API ([why](https://bun.sh/docs/api/websockets#lcYFjkFYJC-summary))
1717
- Zero dependencies with bundled [ws](https://github.com/websockets/ws) types and runtime for [Node.js](https://nodejs.org/) support
1818
- Native integration with [Bun](https://bun.sh/) and [Deno](https://deno.com/) WebSocket API
1919
- Super lightweight tree-shakable packaging
@@ -37,11 +37,11 @@ bun install crossws
3737

3838
## Integration
3939

40-
CrossWS allows integrating your WebSocket handlers with different runtimes and platforms using built-in adapters. Each runtime has specific method of integrating WebSocket. Once integrated, your custom handlers (such as `onMessage`) will work consitent even if you change the runtime!
40+
CrossWS allows integrating your WebSocket handlers with different runtimes and platforms using built-in adapters. Each runtime has a specific method of integrating WebSocket. Once integrated, your custom handlers (such as `onMessage`) will work consistently even if you change the runtime!
4141

4242
### Integration with **Node.js**
4343

44-
In order to integrate crosws with your Node.js HTTP server, you need to connect `upgrade` event to `handleUpgrade` method returned from adapter. Behind the scenes CrossWS uses an embdeded version of [ws](https://github.com/websockets/ws).
44+
To integrate CrossWS with your Node.js HTTP server, you need to connect the `upgrade` event to the `handleUpgrade` method returned from the adapter. Behind the scenes, CrossWS uses an embedded version of [ws](https://github.com/websockets/ws).
4545

4646
```ts
4747
// Initialize Server
@@ -64,7 +64,7 @@ See [playground/node.ts](./playground/node.ts) for demo and [src/adapters/node.t
6464

6565
## Integration with **Bun**
6666

67-
In order to integrate crosws with your Bun server, you need to check for `server.upgrade` and also pass `websocket` object returned from adapter to server options. CrossWS leverages native Bun WebSocket API.
67+
To integrate crosws with your Bun server, you need to check for `server.upgrade` and also pass the `websocket` object returned from the adapter to server options. CrossWS leverages native Bun WebSocket API.
6868

6969
```ts
7070
import bunAdapter from "./dist/adapters/bun";
@@ -90,7 +90,7 @@ See [playground/bun.ts](./playground/bun.ts) for demo and [src/adapters/bun.ts](
9090

9191
## Integration with **Deno**
9292

93-
In order to integrate crosws with your Deno server, you need to check for `upgrade` header than then call `handleUpgrade` method from adapter passing the incoming request object. Returned value is server upgrade response.
93+
To integrate CrossWS with your Deno server, you need to check for the `upgrade` header and then call `handleUpgrade` method from the adapter passing the incoming request object. The returned value is the server upgrade response.
9494

9595
```ts
9696
import denoAdapter from "crossws/adapters/deno";

0 commit comments

Comments
 (0)