Skip to content

Commit 0bb92e6

Browse files
pkgwalexjg
authored andcommitted
Add a JS compatibility note to the README
1 parent 970ed25 commit 0bb92e6

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,19 @@
22

33
Project goal: add an integration layer between [Automerge](https://github.com/automerge/automerge) and client code, compatible with any Rust async runtime.
44

5+
## Compatibility Note
6+
7+
The filesystem disk layout and WebSocket sync protocol implemented in this crate
8+
are not compatible with those of [the JavaScript automerge-repo
9+
implementation][amjs]. An **experimental** Rust implementation that aims for
10+
compatibility with the JS tools is being developed in the [alexjg/samod] repo.
11+
12+
[amjs]: https://github.com/automerge/automerge-repo
13+
[samod]: https://github.com/alexjg/samod
14+
515
## Examples
616

7-
### Multipe TCP clients, one server with hardcoded IP, in memory storage.
17+
### Multiple TCP clients, one server with hardcoded IP, in memory storage.
818

919
1. Start the server:
1020
- `cargo run --example tcp-example --features="tokio" -- --tcp-run-ip 127.0.0.1:2345 --http-run-ip 0.0.0.0:3001`

0 commit comments

Comments
 (0)