coaction 1.4.1 → 2.0.0

package/README.md

@@ -1,11 +1,15 @@
 # coaction
 
-![Node CI](https://github.com/unadlib/coaction/workflows/Node%20CI/badge.svg)
+![Node CI](https://github.com/coactionjs/coaction/workflows/Node%20CI/badge.svg)
 [![npm](https://img.shields.io/npm/v/coaction.svg)](https://www.npmjs.com/package/coaction)
 ![license](https://img.shields.io/npm/l/coaction)
 
 An efficient and flexible state management library for building high-performance, multithreading web applications.
 
+Coaction 2.0 uses `alien-signals` internally for cached getter/computed state,
+React selector reactivity, and adapter-facing subscriptions. The core package
+also re-exports the signal primitives for advanced integrations.
+
 ## Installation
 
 You can install it via npm, yarn or pnpm.
@@ -19,12 +23,44 @@ npm install coaction
 ```jsx
 import { create } from 'coaction';
 
-const useStore = create((set) => ({
+const store = create((set) => ({
+  count: 0,
+  get doubleCount() {
+    return this.count * 2;
+  },
+  increment() {
+    set(() => {
+      this.count += 1;
+    });
+  }
+}));
+```
+
+Accessor getters are cached automatically through the built-in signal runtime.
+Use `get(deps, selector)` when you want to declare dependencies manually:
+
+```ts
+const store = create((set, get) => ({
   count: 0,
-  increment: () => set((state) => state.count++)
+  doubleCount: get(
+    (state) => [state.count],
+    (count) => count * 2
+  ),
+  increment() {
+    set(() => {
+      this.count += 1;
+    });
+  }
 }));
 ```
 
+Advanced integrations can import the native signal primitives and adapter helper
+directly from `coaction`:
+
+```ts
+import { computed, defineExternalStoreAdapter, effect, signal } from 'coaction';
+```
+
 Store methods using `this` are rebound to the latest state when invoked from
 `getState()`, so destructuring remains safe:
 
@@ -44,8 +80,8 @@ increment();
 
 ## API Reference
 
-- [Generated core API index](https://github.com/unadlib/coaction/blob/main/docs/api/core/index.md)
-- [Core API notes](https://github.com/unadlib/coaction/blob/main/docs/api/core/documents/core-api-notes.md)
+- [Generated core API index](https://github.com/coactionjs/coaction/blob/main/docs/api/core/index.md)
+- [Core API notes](https://github.com/coactionjs/coaction/blob/main/docs/api/core/documents/core-api-notes.md)
 
 ### Store Shape Mode (`sliceMode`)
 
@@ -67,4 +103,4 @@ create({ counter: (set) => ({ count: 0 }) }, { sliceMode: 'slices' });
 
 ## Documentation
 
-You can find the documentation [here](https://github.com/unadlib/coaction).
+You can find the documentation [here](https://github.com/coactionjs/coaction).