mirrors/loro
1
0
Fork 0
mirror of https://github.com/loro-dev/loro.git synced 2025-02-06 04:19:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Update README.md

Browse source
This commit is contained in:
Zixuan Chen 2023-11-12 01:50:54 +08:00 committed by GitHub
parent 4c4c397d5d
commit c297534607
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -21,16 +21,14 @@
</a> </a>
</p> </p>
![Rich text example](https://github.com/loro-dev/loro/assets/18425020/54b6975d-ea9e-4c77-9423-c7733b12a251)
> **Notice**: The current API and encoding schema of Loro are **experimental** and **subject to change**. > **Notice**: The current API and encoding schema of Loro are **experimental** and **subject to change**.
Loro is a CRDTs(Conflict-free Replicated Data Types) library that allows you to persist and sync state easily. It is designed to make building [local-first apps][local-first] easier. Loro is a CRDTs(Conflict-free Replicated Data Types) library that allows you to persist and sync state easily. It is designed to make building [local-first apps][local-first] easier.
# Features # Features
> **You can build time travel feature easily with Loro**.
[![Time travel example](https://github.com/loro-dev/loro/assets/18425020/41e10cbc-4940-4bc7-83d5-3cad99783740)](https://github.com/zxch3n/loro-react-flow-example)
## Supported CRDT Algorithms ## Supported CRDT Algorithms
- **Common Data Structures**: Support for `List` for ordered collections, LWW(Last Write Win) `Map` for key-value pairs, `Tree` for hierarchical data, and `Text` for rich text manipulation, enabling various applications. - **Common Data Structures**: Support for `List` for ordered collections, LWW(Last Write Win) `Map` for key-value pairs, `Tree` for hierarchical data, and `Text` for rich text manipulation, enabling various applications.
@ -38,9 +36,6 @@ Loro is a CRDTs(Conflict-free Replicated Data Types) library that allows you to
- **Peritext-like Rich Text CRDT**: Drawing inspiration from [Peritext](https://www.inkandswitch.com/peritext/), Loro manages rich text CRDTs that excel at merging concurrent rich text style edits, maintaining the original intent of users input as much as possible. Details on this will be explored further in an upcoming blog post. - **Peritext-like Rich Text CRDT**: Drawing inspiration from [Peritext](https://www.inkandswitch.com/peritext/), Loro manages rich text CRDTs that excel at merging concurrent rich text style edits, maintaining the original intent of users input as much as possible. Details on this will be explored further in an upcoming blog post.
- **Moveable Tree**: For applications requiring directory-like data manipulation, Loro utilizes the algorithm from [*A Highly-Available Move Operation for Replicated Trees*](https://ieeexplore.ieee.org/document/9563274), which simplifies the process of moving hierarchical data structures. - **Moveable Tree**: For applications requiring directory-like data manipulation, Loro utilizes the algorithm from [*A Highly-Available Move Operation for Replicated Trees*](https://ieeexplore.ieee.org/document/9563274), which simplifies the process of moving hierarchical data structures.
![Rich Text Example](https://github.com/loro-dev/loro/assets/18425020/e1ce3952-c071-40e2-a9b6-51eac78e7622)
## Advanced Features in Loro ## Advanced Features in Loro
- **Preserve Editing History** - **Preserve Editing History**
@ -51,6 +46,10 @@ Loro is a CRDTs(Conflict-free Replicated Data Types) library that allows you to
- **High Performance** - **High Performance**
- [See benchmarks](https://www.loro.dev/docs/performance). - [See benchmarks](https://www.loro.dev/docs/performance).
> **You can build time travel feature easily with Loro**.
[![Time travel example](https://github.com/loro-dev/loro/assets/18425020/41e10cbc-4940-4bc7-83d5-3cad99783740)](https://github.com/zxch3n/loro-react-flow-example)
## Features Provided by CRDTs ## Features Provided by CRDTs
- **Decentralized Synchronization**: Loro allows your app's state synced via p2p connections. - **Decentralized Synchronization**: Loro allows your app's state synced via p2p connections.