@ersbeth/picoflow 1.0.0 → 1.0.1

package/README.md

@@ -1,187 +1,25 @@
 # Picoflow
 
-**Picoflow** is a lightweight reactive dataflow library that provides fine-grained reactive primitives. It gives you an intuitive API for signals, state, asynchronous resources, streams, derivations, effects, and reactive maps. Picoflow uses an explicit tracking context to automatically track reactive dependencies.
+**Picoflow** is a lightweight reactive dataflow library that provides fine-grained reactive primitives. It gives you an intuitive API for signals, state, (asynchronous) derivations, effects, and reactive maps/arrays. Picoflow uses an explicit tracking context to automatically track reactive dependencies.
 
-> **Upgrading from v0.x?** See the [Upgrade Guide](UPGRADING.md) for migration instructions.
-
-## Features
-
-- **Reactive Signals:** Manually trigger updates using `$signal.trigger()`.
-- **Reactive State:** Manage state with observables that expose getter/setter APIs.
-- **Asynchronous Resources:** Fetch and update asynchronous data reactively.
-- **Reactive Streams:** Create streams that update over time using an updater function.
-- **Derivations:** Compute derived values from other reactive primitives.
-  - **Automatic Caching:** Derived values are cached and are re-evaluated only when one or more of their dependencies change.
-  - **Lazy Evaluation:** Derivations are evaluated lazily—that is, the computation only runs if and when an effect actually uses the derived value.
-- **Reactive Maps:** Manage collections reactively with granular update notifications.
-- **Effects:** Automatically run side-effect functions when dependencies change.
-- **Explicit Control:** Choose between reactive (`.get(t)`) and non-reactive (`.pick()`) reads for fine-grained control.
+> **Upgrading from v0.x?** See the [Upgrade Guide](https://ersbeth-web.gitlab.io/picoflow/guide/advanced/upgrading.html) for migration instructions.
 
 ## Installation
 
-Install via npm:
-
 ```bash
+# npm
 npm install @ersbeth/picoflow
-```
-
-## Usage
-
-In Picoflow, we advise to prefix all reactive primitives and effects with `$` for improved readability. Rather than using a subscribe method, you always create an effect that tracks dependencies using a tracking context. Below are some examples:
-
-### Creating a Signal
-
-```ts
-import { signal, effect } from '@ersbeth/picoflow';
-
-const $signal = signal();
-
-const $effect = effect((t) => {
-  // Automatically tracks $signal
-  $signal.watch(t);
-  console.log('$signal has been triggered');
-});
-
-// Trigger the signal
-$signal.trigger();
-
-// LOG -> $signal has been triggered
-```
-
-### Creating Reactive State
-
-```ts
-import { state, effect } from '@ersbeth/picoflow';
-
-const $count = state(0);
-
-const $effect = effect((t) => {
-  // Automatically tracks $count
-  console.log('Count changed:', $count.get(t));
-});
-
-// Update the state
-$count.set(42);
-
-// LOG -> Count changed: 42
-```
-
-### Creating an Asynchronous Resource
-
-```ts
-import { resource, effect } from '@ersbeth/picoflow';
-
-async function fetchData() {
-  const response = await fetch('https://api.example.com/data');
-  return response.json();
-}
-
-const $data = resource(fetchData, {});
-
-// Create an effect to watch for updates
-const $effect = effect((t) => {
-  console.log('Resource updated:', $data.get(t));
-});
-
-// Later, you can trigger a new fetch
-$data.fetch();
-```
-
-### Creating a Reactive Stream
 
-```ts
-import { stream, effect } from '@ersbeth/picoflow';
+# pnpm
+pnpm add @ersbeth/picoflow
 
-const $ticker = stream(
-  (set) => {
-    const interval = setInterval(() => set(Date.now()), 1000);
-    // Return a disposer to clear the interval when the stream is disposed.
-    return () => clearInterval(interval);
-  },
-  Date.now()
-);
-
-const $effect = effect((t) => {
-  console.log('Current time:', $ticker.get(t));
-});
-```
-
-### Creating a Derived Value
-
-```ts
-import { state, derivation, effect } from '@ersbeth/picoflow';
-
-const $a = state(10);
-const $b = state(20);
-
-// Create a derived value that sums $a and $b.
-const $sum = derivation((t) => {
-  return $a.get(t) + $b.get(t);
-});
-
-const $effect = effect((t) => {
-  console.log('Sum:', $sum.get(t));
-});
-
-// Update a dependency to see the derivation update.
-$a.set(15);
-```
-
-### Creating a Reactive Map
-
-Reactive maps allow fine-grained tracking of collection updates.
-
-```ts
-import { map, effect } from '@ersbeth/picoflow';
-
-const $map = map({ foo: 'bar' });
-
-const $effect = effect((t) => {
-  console.log('Map updated:', $map.get(t));
-});
-
-// Update the map to trigger updates
-$map.setAt('baz', 'qux');
-$map.delete('foo');
-```
-
-### Non-Reactive Reads
-
-Sometimes you need to read a value without creating a dependency. Use `pick()` for this:
-
-```ts
-import { state, signal, effect } from '@ersbeth/picoflow';
-
-const $data = state({ count: 0 });
-const $trigger = signal();
-
-const $effect = effect((t) => {
-  // React to $trigger changes only
-  $trigger.watch(t);
-  
-  // Read $data without creating a dependency
-  const snapshot = $data.pick();
-  console.log('Triggered! Current data:', snapshot);
-});
-
-$data.set({ count: 1 });  // Does NOT trigger the effect
-$trigger.trigger();        // Triggers the effect, logs: { count: 1 }
+# yarn
+yarn add @ersbeth/picoflow
 ```
 
 ## Documentation
 
-For comprehensive guides and API documentation, visit:
-
-- **[Getting Started](docs/guide/getting-started.md)** - Quick introduction to PicoFlow
-- **[API Reference](docs/api/index.md)** - Complete API documentation
-
-Or run the documentation locally:
-
-```bash
-pnpm docs:dev
-```
-
-Then open [http://localhost:5173](http://localhost:5173) in your browser.
+For comprehensive guides and API documentation, visit the [official website](https://ersbeth-web.gitlab.io/picoflow/)
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ersbeth/picoflow",
-	"version": "1.0.0",
+	"version": "1.0.1",
 	"description": "Minimal Dataflow librairy for TypeScript",
 	"type": "module",
 	"exports": {