loro/README.md

38 lines
1.3 KiB
Markdown
Raw Normal View History

2022-11-18 10:55:09 +00:00
<p align="center">
<a href="https://loro.dev">
<picture>
2023-02-08 02:54:44 +00:00
<img src="./docs/Loro.svg" width="200"/>
2022-11-18 10:55:09 +00:00
</picture>
2023-02-08 02:54:44 +00:00
<h1 align="center">Loro</h1>
2022-11-18 10:55:09 +00:00
</a>
</p>
2022-10-03 09:35:44 +00:00
2022-11-18 10:55:09 +00:00
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/).
# Why Loro
- 🚀 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
Loro supports a variety of data structures and CRDT algorithms.
- It supports the most used `List`, `Map` and `Text`.
2023-02-08 02:54:44 +00:00
- [WIP] [Peritext](https://www.inkandswitch.com/peritext/) for fine-grind rich text operations
2022-11-18 10:55:09 +00:00
- [TODO] [Moveable Tree]() for directory-like moving operations
- [WIP] Super fast version checkout and undo/redo
# 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
2023-01-11 13:40:16 +00:00