rip out y-websocket-server

Author: dmonad

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Kevin Jahns <[email protected]>.
+Copyright (c) 2025 Kevin Jahns <[email protected]>.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,4 +1,3 @@
-
 # y-websocket :tophat:
 > WebSocket Provider for Yjs
 
@@ -25,8 +24,6 @@ and
 as fallback).
 * Supports exchange of awareness information (e.g. cursors).
 
-
-
 ## Quick Start
 
 ### Install dependencies
@@ -37,11 +34,25 @@ npm i y-websocket
 
 ### Start a y-websocket server
 
-This repository implements a basic server that you can adopt to your specific use-case. [(source code)](./bin/)
+There are multiple y-websocket compatible backends for `y-websocket`: 
+
+* [@y/websocket-server](https://github.com/yjs/y-websocket-server/)
+* hocuspocus
+- y-sweet
+- y-redis
+- ypy-websocket
+- pycrdt-websocket
+- [yrs-warp](https://github.com/y-crdt/yrs-warp)
+- ...
 
-Start a y-websocket server:
+The fastest way to get started is to run the [@y/websocket-server](https://github.com/yjs/y-websocket-server/)
+backend. This package was previously included in y-websocket and now lives in a
+forkable repository.
+
+Install and start y-websocket-server:
 
 ```sh
+npm install @y/y-websocket-server
 HOST=localhost PORT=1234 npx y-websocket
 ```
 
@@ -126,43 +137,6 @@ wsOpts = {
   <dd>Fires when the underlying websocket connection closes with an error. It forwards the websocket event to this event handler.</dd>
 </dl>
 
-## Websocket Server
-
-Start a y-websocket server:
-
-```sh
-HOST=localhost PORT=1234 npx y-websocket
-```
-
-Since npm symlinks the `y-websocket` executable from your local `./node_modules/.bin` folder, you can simply run npx. The `PORT` environment variable already defaults to 1234, and `HOST` defaults to `localhost`.
-
-### Websocket Server with Persistence
-
-Persist document updates in a LevelDB database.
-
-See [LevelDB Persistence](https://github.com/yjs/y-leveldb) for more info.
-
-```sh
-HOST=localhost PORT=1234 YPERSISTENCE=./dbDir node ./node_modules/y-websocket/bin/server.cjs
-```
-
-### Websocket Server with HTTP callback
-
-Send a debounced callback to an HTTP server (`POST`) on document update. Note that this implementation doesn't implement a retry logic in case the `CALLBACK_URL` does not work.
-
-Can take the following ENV variables:
-
-* `CALLBACK_URL` : Callback server URL
-* `CALLBACK_DEBOUNCE_WAIT` : Debounce time between callbacks (in ms). Defaults to 2000 ms
-* `CALLBACK_DEBOUNCE_MAXWAIT` : Maximum time to wait before callback. Defaults to 10 seconds
-* `CALLBACK_TIMEOUT` : Timeout for the HTTP call. Defaults to 5 seconds
-* `CALLBACK_OBJECTS` : JSON of shared objects to get data (`'{"SHARED_OBJECT_NAME":"SHARED_OBJECT_TYPE}'`)
-
-```sh
-CALLBACK_URL=http://localhost:3000/ CALLBACK_OBJECTS='{"prosemirror":"XmlFragment"}' npm start
-```
-This sends a debounced callback to `localhost:3000` 2 seconds after receiving an update (default `DEBOUNCE_WAIT`) with the data of an XmlFragment named `"prosemirror"` in the body.
-
 ## License
 
 [The MIT License](./LICENSE) © Kevin Jahns