rhine-var 0.3.1 → 0.3.2

package/README.md

@@ -12,40 +12,41 @@ Developing collaborative applications has never been this easy.
 
 </div>
 
+<br/>
 
 ## Why Choose RHINE-VAR ?
 
-#### Concise and Efficient Syntax Design
+### Concise and Efficient Syntax Design
 RhineVar draws inspiration from the design philosophy of the Valtio state management library, significantly reducing the learning curve. Developers can easily manage collaborative data as if they were manipulating regular variables.
 
-#### Comprehensive Type Support
+### Comprehensive Type Support
 RhineVar offers full type hints and checks, ensuring precise code completion and static analysis during development. This not only improves the development experience but also reduces potential errors, making it especially suitable for TypeScript projects, enhancing code safety and reliability.
 
-#### Distributed Real-time Collaboration Algorithm
+### Distributed Real-time Collaboration Algorithm
 The underlying collaboration algorithm of RhineVar is powered by the robust Yjs library. Using the CRDT (Conflict-free Replicated Data Type) algorithm, it ensures eventual consistency even in multi-user and offline environments.
 
-#### High Performance with Low Bandwidth Requirements
+### High Performance with Low Bandwidth Requirements
 The data synchronization and conflict resolution mechanism is highly efficient. Leveraging Yjs's incremental update mechanism, only necessary data changes are transmitted rather than the entire document, making it ideal for bandwidth-constrained environments and reducing unnecessary data transfers.
 
-#### Strong Offline Support
+### Strong Offline Support
 Users can continue to work even while offline. Once reconnected, all changes are automatically synchronized, ensuring no data is lost or conflicted. This is crucial for building offline-first applications.
 
-#### Cross-platform and Framework Agnostic
+### Cross-platform and Framework Agnostic
 RhineVar can be used in various environments, including browsers, Node.js, and other JavaScript platforms. It integrates with multiple frontend frameworks and libraries such as Next.js, React, Vue.js, ProseMirror, and more.
 
-#### Lightweight and Extensible
+### Lightweight and Extensible
 RhineVar is a highly lightweight library, with its core package only a few KB in size, making it suitable for various frontend applications. Its modular architecture supports feature extensions, allowing developers to import or develop custom modules as needed.
 
-#### Decentralized Architecture
+### Decentralized Architecture
 With a decentralized architecture, collaborative editing becomes more scalable, efficient, and fault-tolerant. Peer-to-peer data transfer is supported without relying on a central server (currently under development).
 
-#### Native Yjs Support
+### Native Yjs Support
 RhineVar offers full support for native Yjs object operations, providing lower-level, richer API support. Direct operations on Yjs objects automatically trigger updates in RhineVar.
 
-#### More Friendly and Complete Event System
+### More Friendly and Complete Event System
 RhineVar offers an extensive event subscription and listening system with intuitive data change events. It also supports deep data change monitoring within objects, catering to a wide range of use cases.
 
-
+<br/>
 
 ## Contact Us
 Welcome to join our WeChat group for communication. We look forward to having more community members participate in the creation of rhine-var.
@@ -62,6 +63,8 @@ yarn add rhine-var
 ```
 If you don't have `yarn`, you can install it via `npm i rhine-var`, or install `yarn` first using `npm i -g yarn` and then use the command above to install.
 
+<br/>
+
 ## Usage
 
 ```typescript jsx
@@ -79,11 +82,11 @@ function Counter() {
   </div>
 }
 ```
-#### Default Value
+### Default Value
 
 When the room does not exist on the server, a default value will be used to create the room. If not connected to the server, data from the default value will also be returned.
 
-#### Room ID
+### Room ID
 
 The `Same Room ID` manages the `Same State Variables`, and users who join will experience real-time multi-user collaboration.
 

package/README_zh.md

@@ -10,12 +10,13 @@
 
 </div>
 
+<br/>
 
 ## 为什么选择 RHINE-VAR ?
 
 **简洁高效的语法设计:** &nbsp; RhineVar 借鉴了 Valtio 状态管理库的设计理念，极大地降低了学习成本。开发者可以像操作普通变量一样轻松操控协同数据。
 
-**完备的类型支持：** &nbsp; RhineVar 提供全面的类型提示和类型检查，确保在开发过程中能够获得精确的代码补全和静态分析。这不仅改善了开发体验，还有效降低了潜在的错误风险，特别适用于 TypeScript 项目，提升了代码的安全性和可靠性。
+**完备的类型支持:** &nbsp; RhineVar 提供全面的类型提示和类型检查，确保在开发过程中能够获得精确的代码补全和静态分析。这不仅改善了开发体验，还有效降低了潜在的错误风险，特别适用于 TypeScript 项目，提升了代码的安全性和可靠性。
 
 **分布式实时协作算法:** &nbsp; RhineVar 的底层协同算法基于强大的 Yjs 库。通过 CRDT (Conflict-free Replicated Data Type，无冲突复制数据类型) 算法，确保多用户同时使用，甚至离线下使用的最终一致性。
 
@@ -33,6 +34,7 @@
 
 **更友好且完善的事件体系:** &nbsp; RhineVar 提供了丰富的事件订阅监听方式，直观的数据变更事件，更好的支持数据变更的监听和处理。以及提供了对内部深层数据变化的监听，以适用更多场景。
 
+<br/>
 
 ## Contact Us
 
@@ -50,6 +52,8 @@ yarn add rhine-var
 ```
 如果你的电脑未安装`yarn`, 也可通过 `npm i rhine-var` 安装。或先用 `npm i -g yarn` 安装`yarn`，然后再用上方命令进行安装。
 
+<br/>
+
 ## Usage
 
 ```typescript jsx
@@ -67,11 +71,11 @@ function Counter() {
   </div>
 }
 ```
-#### Default Value
+### Default Value
 
 当服务端无信息时，将使用 DefaultValue 作为默认内容。未连接到服务器时，也将根据默认值进行返回。
 
-#### Room ID
+### Room ID
 
 一个房间号对应一个状态变量, 加入到一个房间中的用户会参与到多人协同中。
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rhine-var",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "description": "Variables that support multi-user collaboration and persistence, making collaboration and variable operations as simple as possible, with strict and well-defined type hints.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",