docs: update readme

This commit is contained in:
Zixuan Chen 2023-10-29 21:37:24 +08:00
parent d942e3d7a2
commit ce8dc9284d
No known key found for this signature in database

View file

@ -3,35 +3,66 @@
<picture>
<img src="./docs/Loro.svg" width="200"/>
</picture>
<h1 align="center">Loro</h1>
</a>
</p>
<h1 align="center">
Loro<br/>
Sync state easily with CRDTs
</h1>
<p align="center">
<a aria-label="X" href="https://x.com/loro_dev">
<img alt="" src="https://img.shields.io/badge/Twitter-black?style=for-the-badge&logo=Twitter">
</a>
<a aria-label="Discord-Link" href="https://discord.gg/tUsBSVfqzf">
<img alt="" src="https://img.shields.io/badge/Discord-black?style=for-the-badge&logo=discord">
</a>
</p>
Loro is a fast [CRDT](https://crdt.tech/) framework with built-in end-to-end encryption ability.
It provides a set of data structures that can automatically sync without any conflict. With end-to-end encryption addon, all data can be encrypted without losing the ability to collaborate with the others. It aims to be the engine for building [local-first software](https://www.inkandswitch.com/local-first/).
> **Notice**: The current API and encoding schema of Loro are experimental and subject to change. It is not recommended for use in production environments at this time.
Loro is a CRDTs(Conflict-free Replicated Data Types) library that allows you to persist and sync state easily. It is designed for building [local-first software][local-first].
# Why Loro
**What are CRDTs**? Conflict-free Replicated Data Types (CRDTs) are data structures that enable automatic conflict resolution. It allows users to make changes together, in real-time or asynchronously, without conflicting and without relying on a central server.
- 🚀 It is pretty fast
- 🔒 [WIP] Security built-in
- 💻 Syncing data made easy
- 📜 Preserve all history with low overhead
- 🪐 [WIP] Time travel the history in milliseconds
# Features
Loro supports a variety of data structures and CRDT algorithms.
## Supported CRDT Algorithms
- It supports the most used `List`, `Map` and `Text`.
- [WIP] [Peritext](https://www.inkandswitch.com/peritext/) for fine-grind rich text operations
- [TODO] [Moveable Tree]() for directory-like moving operations
- [WIP] Super fast version checkout and undo/redo
- **Basic Data Structures**: Includes 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 a wide variety of applications.
- **Text Editing with Fugue**: Loro integrate [Fugue](https://arxiv.org/abs/2305.00583), a sophisticated CRDT algorithm designed to minimize conflicts in text editing, which is particularly useful for collaborative document editing.
- **Rich Text with Peritext-like 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 each user's input as much as possible. Details on this will be explored further in an upcoming blog post.
- **Hierarchical Data with 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 and reorganizing hierarchical data structures.
### Advanced Editing Features
- **Preserve Editing History**
- With Loro, you can track changes effortlessly as it records the editing history with low overhead.
- This feature is essential for audit trails, undo/redo functionality, and understanding the evolution of your data over time.
- **Time Travel Through History**
- It allows users to compare and merge manually when needed, although CRDTs typically resolve conflicts well.
### Other Features
- **High Performance**
- **Decentralized Synchronization**: Loro allows your app's state can be synced via p2p connections.
- **Automatic Merging**: Say goodbye to merge conflicts. Loro guarantees eventual consistency, automating the merging of concurrent changes.
- **Local Availability**: Data is persistently available on users' devices, ensuring offline functionality and real-time responsiveness.
- **Scalability**: Effortlessly scale your application horizontally thanks to the inherently distributed nature of CRDTs.
- **Delta Updates**: Loro has out-of-the-box support for delta updates.
# Credits
- Automerge for its columnar encoding algorithm
- Yjs for the efficient algorithm of merging blocks
- Diamond-types for its idea of low-overhead merging algorithm
- Ink & Switch for Local-first Software and Peritext
Loro draws inspiration from the innovative work of the following projects and individuals:
- [Ink & Switch](https://inkandswitch.com/): The principles of Local-first Software have greatly influenced this project. The [Peritext](https://www.inkandswitch.com/peritext/) project has also shaped our approach to rich text CRDTs.
- [Diamond-types](https://github.com/josephg/diamond-types): The ingenious OT-like merging algorithm from @josephg has been adapted to reduce the computation and space usage of CRDTs.
- [Automerge](https://github.com/automerge/automerge): Their use of columnar encoding for CRDTs has informed our strategies for efficient data encoding.
- [Yjs](https://github.com/yjs/yjs): We have incorporated a similar algorithm for the effective merging of collaborative editing operations, thanks to their pioneering contributions.
- [Matthew Weidner](https://mattweidner.com/): His work on the [Fugue](https://arxiv.org/abs/2305.00583) algorithm has been invaluable, enhancing our text editing capabilities.
[local-first]: https://www.inkandswitch.com/local-first/
[Fugue]: https://arxiv.org/abs/2305.00583
[Peritext]: https://www.inkandswitch.com/peritext/