Skip to content

Commit

Permalink
feat: update readme (#529)
Browse files Browse the repository at this point in the history
  • Loading branch information
darkskygit authored Sep 4, 2023
1 parent ad51b2c commit a5dd80a
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 7 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions apps/homepage/pages/docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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
4 changes: 2 additions & 2 deletions apps/homepage/pages/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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

1 comment on commit a5dd80a

@vercel
Copy link

@vercel vercel bot commented on a5dd80a Sep 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.