From a5dd80a07189d68210e27476d60cf89e6126afcc Mon Sep 17 00:00:00 2001 From: DarkSky <25152247+darkskygit@users.noreply.github.com> Date: Mon, 4 Sep 2023 15:22:01 +0800 Subject: [PATCH] feat: update readme (#529) --- README.md | 5 ++--- apps/homepage/pages/docs/introduction.md | 4 ++-- apps/homepage/pages/index.mdx | 4 ++-- 3 files changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 51cb19d43..61c846a48 100644 --- a/README.md +++ b/README.md @@ -46,8 +46,7 @@ Additionally, OctoBase can function as a standalone server database, or it can b OctoBase has been used in [AFFiNE Cloud]. We are currently working on the following components: - Core - - ✅ CRDT operation (based on yrs) - - 🚧 CRDT operation (based on [jwst-codec]) + - ✅ CRDT operation (based on [y-octo]) - ✅ CRDT-based data structure compatible with [blocksuite] - 🚧 Full-text indexing - Sync @@ -142,7 +141,7 @@ Currently, this repository is under **active development** and most components a [Issues Closed]: https://img.shields.io/github/issues-closed/toeverything/OctoBase?color=6880ff&logo=github [rust-version-icon]: https://img.shields.io/badge/Rust-1.70.0-dea584?logo=rust [affine cloud]: https://app.affine.pro -[jwst-codec]: ./libs/jwst-codec/ +[y-octo]: https://github.com/toeverything/y-octo [blocksuite]: https://github.com/toeverything/blocksuite [Collaboration abstraction]: https://github.com/toeverything/OctoBase/issues/287 [WebSocket connector]: ./libs/jwst-rpc/src/connector/tungstenite_socket.rs diff --git a/apps/homepage/pages/docs/introduction.md b/apps/homepage/pages/docs/introduction.md index 3a8ff8437..4f14626af 100644 --- a/apps/homepage/pages/docs/introduction.md +++ b/apps/homepage/pages/docs/introduction.md @@ -16,7 +16,7 @@ OctoBase also offers a Block-based full-text indexing and query interface, makin ## CRDT-driven P2P synchronization -All Blocks within OctoBase are CRDTs, which are built on the [yrs] and can interact with [blocksuite] / [yjs]. +All Blocks within OctoBase are CRDTs, which are built on the [y-octo] and can interact with [blocksuite] / [yjs]. CRDT is a distributed data structure that ensures eventual consistency without requiring a central server or coordination algorithm like Raft. This allows OctoBase to provide high-performance, local-first data read/write services. @@ -34,4 +34,4 @@ OctoBase also offers ffi binding support for common programming languages. This [blocksuite]: https://github.com/toeverything/blocksuite [yjs]: https://github.com/yjs/yjs -[yrs]: https://github.com/y-crdt/y-crdt +[y-octo]: https://github.com/toeverything/y-octo diff --git a/apps/homepage/pages/index.mdx b/apps/homepage/pages/index.mdx index 3a8ff8437..4f14626af 100644 --- a/apps/homepage/pages/index.mdx +++ b/apps/homepage/pages/index.mdx @@ -16,7 +16,7 @@ OctoBase also offers a Block-based full-text indexing and query interface, makin ## CRDT-driven P2P synchronization -All Blocks within OctoBase are CRDTs, which are built on the [yrs] and can interact with [blocksuite] / [yjs]. +All Blocks within OctoBase are CRDTs, which are built on the [y-octo] and can interact with [blocksuite] / [yjs]. CRDT is a distributed data structure that ensures eventual consistency without requiring a central server or coordination algorithm like Raft. This allows OctoBase to provide high-performance, local-first data read/write services. @@ -34,4 +34,4 @@ OctoBase also offers ffi binding support for common programming languages. This [blocksuite]: https://github.com/toeverything/blocksuite [yjs]: https://github.com/yjs/yjs -[yrs]: https://github.com/y-crdt/y-crdt +[y-octo]: https://github.com/toeverything/y-octo