ThetaDev/automerge
1
0
Fork 0
Code Issues Pull requests Projects Releases Activity

Update readme sections mentioning performance branch ()

Browse source
This commit is contained in:
Andrew Jeffery 2021-07-13 16:28:08 +01:00 • committed by GitHub
parent fa9361f780
commit a8d133beb2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 20 deletions

31
README.md
View file

@ -5,51 +5,42 @@
[![Build Status](https://travis-ci.com/automerge/automerge-rs.svg?branch=main)](https://travis-ci.com/automerge/automerge-rs)
This is a rust implementation of
[automerge](https://github.com/automerge/automerge). Currently this repo
[automerge](https://github.com/automerge/automerge). This repo
contains an implementation of the "backend" of the Automerge library, designed
to be used via FFI from many different platforms. Very soon there will also be
a frontend which will be designed for Rust application developers to use.
This project is tracking the `performance` branch of the JavaScript reference implementation of Automerge. The `performance` branch contains a lot of backwards incompatible changes and is intended to become a 1.0 release of the library, you can find more information about that [here](https://github.com/automerge/automerge/pull/253). Our goal is to release a pre 1.0 version of the rust library once the JavaScript library hits 1.0. As such we are keeping this project up to date with the frequent and often quite large changes in the `performance` branch of the JavaScript repo - that is to say, don't depend on anything in this repo to stay constant right now.
to be used via FFI from many different platforms, as well as a native Rust "frontend".
## Using automerge-backend-wasm with automerge
This backend is tracking the [performance branch of automerge](https://github.com/automerge/automerge/tree/performance)
To build the wasm backend you'll need to install [wasm-pack](https://rustwasm.github.io/wasm-pack/installer/). Then:
```
$ cd automerge-backend-wasm
$ yarn release
$ cd automerge-backend-wasm
$ yarn release
```
Once it is built set the new default backend in your js application like this.
```js
const wasmBackend = require(path.resolve(WASM_BACKEND_PATH))
Automerge.setDefaultBackend(wasmBackend)
const wasmBackend = require(path.resolve(WASM_BACKEND_PATH));
Automerge.setDefaultBackend(wasmBackend);
```
and export `WASM_BACKEND_PATH="$path_to_automerge_backend_wasm/build"` before running.
## Backend? Frontend?
Automerge is a JSON CRDT, in this sense it is just a data structure with a set
of rules about how to merge two different versions of that data structure.
However, in practice one often needs two separate roles when writing
applications which use the CRDT:
applications which use the CRDT:
- A very low latency process, usually running on some kind of UI thread, which
records changes made by the user and reflects them in the UI
- A less latency sensitive process which executes the complex logic of merging changes
received from the UI and over the network and send diffs to the frontend to apply
More details can be found [here](https://github.com/automerge/automerge/blob/performance/BINARY_FORMAT.md).
Note that the performance branch of automerge is under active development and is changing quickly.
More details can be found [here](https://github.com/automerge/automerge/blob/main/BINARY_FORMAT.md).
## Community
Development of automerge rust is currently being coordinated at our [slack channel](https://automerge.slack.com/archives/CTQARU3NZ). Come say hi. =)
Development of automerge rust is currently being coordinated at our [slack channel](https://automerge.slack.com/archives/CTQARU3NZ). Come say hi. =)