Update readme and agent config to reality
This commit is contained in:
parent
8671265479
commit
ece0618a17
2 changed files with 28 additions and 6 deletions
15
CLAUDE.md
15
CLAUDE.md
|
|
@ -3,6 +3,21 @@
|
||||||
daemon + thin adapters architecture. daemon handles yjs crdt, adapters just
|
daemon + thin adapters architecture. daemon handles yjs crdt, adapters just
|
||||||
hook buffer events and apply remote changes.
|
hook buffer events and apply remote changes.
|
||||||
|
|
||||||
|
## status
|
||||||
|
|
||||||
|
working:
|
||||||
|
- daemon with room-based sessions
|
||||||
|
- multi-peer sync (tested with 2+ clients)
|
||||||
|
- vim9 adapter with live buffer sync
|
||||||
|
- proper crdt diffing (not delete-all-insert-all)
|
||||||
|
- integration tests for concurrent edits
|
||||||
|
|
||||||
|
not yet:
|
||||||
|
- cursor/selection sync (awareness protocol stubbed but unused)
|
||||||
|
- other editor adapters (helix, kakoune, zed)
|
||||||
|
- persistence (rooms are ephemeral)
|
||||||
|
- reconnection handling
|
||||||
|
|
||||||
## stack
|
## stack
|
||||||
|
|
||||||
- bun runtime
|
- bun runtime
|
||||||
|
|
|
||||||
19
README.md
19
README.md
|
|
@ -1,15 +1,22 @@
|
||||||
# collabd
|
# collabd
|
||||||
|
|
||||||
To install dependencies:
|
editor-agnostic collaborative editing daemon. two vims, one buffer.
|
||||||
|
|
||||||
|
## quick start
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
bun install
|
bun install
|
||||||
|
just dev # starts daemon on :4040
|
||||||
```
|
```
|
||||||
|
|
||||||
To run:
|
in vim (requires 9.0+):
|
||||||
|
```vim
|
||||||
```bash
|
:source adapters/vim/collab.vim
|
||||||
bun run src/index.ts
|
:CollabJoin roomname
|
||||||
```
|
```
|
||||||
|
|
||||||
This project was created using `bun init` in bun v1.3.5. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.
|
open another vim, join the same room, type in either. magic.
|
||||||
|
|
||||||
|
## more info
|
||||||
|
|
||||||
|
see CLAUDE.md for architecture, protocol, and how to add new editor adapters.
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue