Skip to content

Commit a5dd80a

Browse files
authored
feat: update readme (#529)
1 parent ad51b2c commit a5dd80a

File tree

3 files changed

+6
-7
lines changed

3 files changed

+6
-7
lines changed

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,7 @@ Additionally, OctoBase can function as a standalone server database, or it can b
4646
OctoBase has been used in [AFFiNE Cloud]. We are currently working on the following components:
4747

4848
- Core
49-
- ✅ CRDT operation (based on yrs)
50-
- 🚧 CRDT operation (based on [jwst-codec])
49+
- ✅ CRDT operation (based on [y-octo])
5150
- ✅ CRDT-based data structure compatible with [blocksuite]
5251
- 🚧 Full-text indexing
5352
- Sync
@@ -142,7 +141,7 @@ Currently, this repository is under **active development** and most components a
142141
[Issues Closed]: https://img.shields.io/github/issues-closed/toeverything/OctoBase?color=6880ff&logo=github
143142
[rust-version-icon]: https://img.shields.io/badge/Rust-1.70.0-dea584?logo=rust
144143
[affine cloud]: https://app.affine.pro
145-
[jwst-codec]: ./libs/jwst-codec/
144+
[y-octo]: https://github.com/toeverything/y-octo
146145
[blocksuite]: https://github.com/toeverything/blocksuite
147146
[Collaboration abstraction]: https://github.com/toeverything/OctoBase/issues/287
148147
[WebSocket connector]: ./libs/jwst-rpc/src/connector/tungstenite_socket.rs

apps/homepage/pages/docs/introduction.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ OctoBase also offers a Block-based full-text indexing and query interface, makin
1616

1717
## CRDT-driven P2P synchronization
1818

19-
All Blocks within OctoBase are CRDTs, which are built on the [yrs] and can interact with [blocksuite] / [yjs].
19+
All Blocks within OctoBase are CRDTs, which are built on the [y-octo] and can interact with [blocksuite] / [yjs].
2020

2121
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.
2222

@@ -34,4 +34,4 @@ OctoBase also offers ffi binding support for common programming languages. This
3434

3535
[blocksuite]: https://github.com/toeverything/blocksuite
3636
[yjs]: https://github.com/yjs/yjs
37-
[yrs]: https://github.com/y-crdt/y-crdt
37+
[y-octo]: https://github.com/toeverything/y-octo

apps/homepage/pages/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ OctoBase also offers a Block-based full-text indexing and query interface, makin
1616

1717
## CRDT-driven P2P synchronization
1818

19-
All Blocks within OctoBase are CRDTs, which are built on the [yrs] and can interact with [blocksuite] / [yjs].
19+
All Blocks within OctoBase are CRDTs, which are built on the [y-octo] and can interact with [blocksuite] / [yjs].
2020

2121
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.
2222

@@ -34,4 +34,4 @@ OctoBase also offers ffi binding support for common programming languages. This
3434

3535
[blocksuite]: https://github.com/toeverything/blocksuite
3636
[yjs]: https://github.com/yjs/yjs
37-
[yrs]: https://github.com/y-crdt/y-crdt
37+
[y-octo]: https://github.com/toeverything/y-octo

0 commit comments

Comments
 (0)