@yiin/reactive-proxy-state 1.0.6 → 1.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +6 -2
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,11 +1,15 @@
1
1
  # Reactive Proxy State
2
2
 
3
- [![npm version](https://badge.fury.io/js/%40yiin%2Freactive-proxy-state.svg)](https://badge.fury.io/js/%40yiin%2Freactive-proxy-state) <!-- Replace @yiin/reactive-proxy-state -->
3
+ [![npm version](https://badge.fury.io/js/%40yiin%2Freactive-proxy-state.svg)](https://badge.fury.io/js/%40yiin%2Freactive-proxy-state) [![Tests](https://github.com/Yiin/reactive-proxy-state/actions/workflows/test.yml/badge.svg)](https://github.com/Yiin/reactive-proxy-state/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/Yiin/reactive-proxy-state/branch/main/graph/badge.svg)](https://codecov.io/gh/Yiin/reactive-proxy-state)
4
4
 
5
- A simple, standalone reactivity library inspired by Vue 3's reactivity system, designed for use outside of Vue, particularly in server-side contexts or for data synchronization tasks. It uses JavaScript Proxies to track changes in plain objects, Arrays, Maps, and Sets.
5
+ A simple, standalone reactivity library inspired by Vue 3's reactivity system, designed for use outside of Vue, particularly in server-side contexts or for data synchronization tasks. It uses JavaScript Proxies to track changes in plain objects, Arrays, Maps, and Sets. Notably, it includes mechanisms for serializing and applying state changes (see [`updateState`](./docs/api/update-state.md)), enabling use cases like state replication between different environments (e.g., server-client, main thread-worker), a feature not typically found in core reactivity libraries.
6
6
 
7
7
  **Note:** This library currently only supports synchronous effect execution.
8
8
 
9
+ ## Documentation
10
+
11
+ For comprehensive documentation, visit our [documentation site](https://Yiin.github.io/reactive-proxy-state/).
12
+
9
13
  ## Installation
10
14
 
11
15
  ```bash
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@yiin/reactive-proxy-state",
3
3
  "private": false,
4
- "version": "1.0.6",
4
+ "version": "1.0.8",
5
5
  "description": "A simple, standalone reactivity library using Proxies",
6
6
  "main": "dist/index.js",
7
7
  "types": "dist/index.d.ts",
@@ -44,7 +44,7 @@
44
44
  "bugs": {
45
45
  "url": "https://github.com/Yiin/reactive-proxy-state/issues"
46
46
  },
47
- "homepage": "https://github.com/Yiin/reactive-proxy-state#readme",
47
+ "homepage": "https://Yiin.github.io/reactive-proxy-state/",
48
48
  "publishConfig": {
49
49
  "access": "public"
50
50
  },