@atolljs/solidjs 0.1.0 → 0.1.2

package/README.md

@@ -1,9 +1,53 @@
 # @atolljs/solidjs
 
-SolidJS bindings for `@atolljs/core` — framework adapter only, no domain code.
+SolidJS bindings for `@atolljs/core` — shared-memory fields and worker tasks as
+natively tracked `Accessor`s (the SDK uses `solid-js` internally for its
+reactive core). Subscriptions auto-dispose via `onCleanup` when the owner is
+destroyed.
 
-- `createObservable(source)` — any `ObservableValue` as an `Accessor`.
-- `createSharedValue(memory, key)` — a shared-memory field as an `Accessor`.
-- `createTask(task)` — `{ state }` Accessor of the task snapshot plus `run`/`runOnce`.
+**[Atoll — package documentation](https://jwhenry3.github.io/atolljs/consumer/quickstart/)**
 
-The consuming app composes these with its own contracts and tasks.
+## Install
+
+```bash
+npm install @atolljs/core @atolljs/solidjs
+```
+
+## Usage
+
+```tsx
+import { createSharedValue, createTask } from '@atolljs/solidjs';
+import { counterMemory } from './counter.memory';
+import { counter } from './counter';
+
+export function App() {
+  const count = createSharedValue(counterMemory, 'count');
+  const increment = createTask(counter.increment);
+
+  return (
+    <button onClick={() => increment.run(1)}>
+      count: {count() ?? '…'}
+    </button>
+  );
+}
+```
+
+## API
+
+- `createObservable(source)` — subscribe to any `ObservableValue` snapshot as
+  an `Accessor`.
+- `createSharedValue(memory, key, select?, options?)` — bind one shared-memory
+  field to an `Accessor`; optional selector + `equals`.
+- `createTask(task | asyncFn)` — bind an `AsyncTask` (or any async fn) to
+  `{ state: Accessor<TaskSnapshot> }` plus `run`/`runOnce` triggers.
+
+## Notes
+
+- Worker-hosted Solid trees (islands) live in the companion package
+  [`@atolljs/solid-island`](../solid-island).
+
+## Documentation
+
+- [Atoll — package documentation](https://jwhenry3.github.io/atolljs/consumer/quickstart/)
+- [SolidJS guide](https://jwhenry3.github.io/atolljs/consumer/fw-solid/)
+- [Worker islands for Solid](https://jwhenry3.github.io/atolljs/consumer/fw-solid/worker-islands/)

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@atolljs/solidjs",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "SolidJS bindings — createObservable, createSharedValue, createTask",
+  "homepage": "https://jwhenry3.github.io/atolljs/consumer/quickstart/",
   "type": "module",
   "exports": {
     ".": "./src/index.ts"
@@ -10,15 +11,19 @@
     "src"
   ],
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
   },
   "peerDependencies": {
-    "@atolljs/core": "0.1.0",
+    "@atolljs/core": "0.1.2",
     "solid-js": "^1.9.15"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/jwhenry3/atolljs",
     "directory": "packages/solidjs"
+  },
+  "bugs": {
+    "url": "https://github.com/jwhenry3/atolljs/issues"
   }
 }