Add stack to readme
This commit is contained in:
parent
8663071299
commit
999e409799
1 changed files with 9 additions and 4 deletions
13
README.md
13
README.md
|
|
@ -1,12 +1,12 @@
|
||||||
# collabd
|
# collabd
|
||||||
|
|
||||||
editor-agnostic collaborative editing daemon. two vims, one buffer.
|
editor-agnostic collaborative editing daemon
|
||||||
|
|
||||||
## quick start
|
## quick start
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
bun install
|
bun install
|
||||||
just dev # starts daemon on :4040
|
just dev # starts daemon on :4040
|
||||||
```
|
```
|
||||||
|
|
||||||
in vim (requires 9.0+):
|
in vim (requires 9.0+):
|
||||||
|
|
@ -15,8 +15,13 @@ in vim (requires 9.0+):
|
||||||
:CollabJoin roomname
|
:CollabJoin roomname
|
||||||
```
|
```
|
||||||
|
|
||||||
open another vim, join the same room, type in either. magic.
|
## stack
|
||||||
|
|
||||||
|
- bun runtime
|
||||||
|
- yjs for crdt
|
||||||
|
- websocket transport
|
||||||
|
- vim9script adapter (with bun bridge since vim can't do websocket)
|
||||||
|
|
||||||
## more info
|
## more info
|
||||||
|
|
||||||
see CLAUDE.md for architecture, protocol, and how to add new editor adapters.
|
see [CLAUDE.md] for architecture, protocol, and how to add new editor adapters.
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue