Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
pi0 committed Aug 7, 2024
1 parent b665048 commit 2e49cc3
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 26 deletions.
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ⛨ CrossWS
# crossws

<!-- automd:badges -->

Expand All @@ -7,24 +7,23 @@

<!-- /automd -->

Elegant, typed, and simple interface to implement platform-agnostic WebSocket servers.
Elegant, typed, and simple toolkit to implement cross-platform WebSocket servers.

👉 [📖 documentation](https://crossws.unjs.io)

## Features

🧩 Seamlessly integrates with, [Bun](https://bun.sh/), [Deno](https://deno.com/), [Cloudflare Workers](https://workers.cloudflare.com/) and [Node.js](https://nodejs.org/en) ([ws](https://github.com/websockets/ws) || [uWebSockets](https://github.com/uNetworking/uWebSockets.js)).
🧩 Seamlessly integrates with [Bun](https://crossws.unjs.io/adapters/bun), [Cloudflare Workers](https://crossws.unjs.io/adapters/cloudflare), [Deno](https://crossws.unjs.io/adapters/deno) and [Node.js](https://crossws.unjs.io/adapters/node) and any compatible web framework.

🚀 High-performance server hooks, avoiding heavy per-connection events API ([why](https://bun.sh/docs/api/websockets#lcYFjkFYJC-summary))
✅ Prebundled with [ws](https://github.com/websockets/ws) for Node.js support with alternative/much faster [uWebSockets](https://crossws.unjs.io/adapters/node#uwebsockets) adapter.

📦 No external dependencies, includes [ws](https://github.com/websockets/ws) for Node.js support
📦 Extremely lightweight and tree-shakable conditional ESM exports.

💡 Extremely lightweight and tree-shakable packaging with ESM and CJS support
🚀 High-performance and simple hooks API, without per-connection callback creation.

🔍 Developer-friendly object logging
🌟 Typed hooks API and developer-friendly object inspection.

> [!IMPORTANT]
> This project and API are under development.
[^1]: crossws supports Node.js via [npm:ws](https://github.com/websockets/ws) (prebundled) or [uWebSockets.js](https://github.com/uNetworking/uWebSockets.js).

## Contribution

Expand Down
27 changes: 10 additions & 17 deletions docs/.config/docs.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# yaml-language-server: $schema=https://unpkg.com/undocs/schema/config.json

name: crossws
shortDescription: runtime agnostic websocket servers
description: Unified WebSocket API for Node.js, Deno, Bun and Cloudflare
Workers.
shortDescription: Unified WebSocket Servers
description: elegant, typed, and simple toolkit to implement cross-platform WebSocket servers.
github: unjs/crossws
landing:
heroLinks:
Expand All @@ -12,17 +11,11 @@ landing:
icon: i-heroicons-play
to: https://stackblitz.com/github/unjs/crossws/tree/main/examples/h3?file=app.ts
features:
- title: Runtime Agnostic
description:
Seamlessly integrates with Bun, Deno, Cloudflare Workers and Node.js
(ws or uWebSockets.js)
- title: Made for Performance
description:
High-performance server hooks API designed to avoid creating callbacks
per client but once.
- title: Lightweight
description:
Zero Dependency with bundled support for Node.js support. Extremely lightweight
and tree-shakable packaging with ESM and CJS support.
- title: Developer Friendly
description: Typed Hooks API and human friendly logging support.
- title: 🧩 Pluggable
description: Seamlessly integrates with [Bun](https://crossws.unjs.io/adapters/bun), [Cloudflare Workers](https://crossws.unjs.io/adapters/cloudflare), [Deno](https://crossws.unjs.io/adapters/deno) and [Node.js](https://crossws.unjs.io/adapters/node) and any compatible web framework.
- title: 📦 Lightweight
description: Extremely lightweight and tree-shakable conditional ESM exports. Prebundled with [ws](https://github.com/websockets/ws) for Node.js support.
- title: 🚀 Made for Performance
description: High-performance and simple hooks API, without per-connection callback creation.
- title: 🌟 Developer Friendly
description: Typed hooks API and developer-friendly object inspection.

0 comments on commit 2e49cc3

Please sign in to comment.