@outbuild-company/schedule-core 1.10.1 → 1.10.3

package/README.md

@@ -15,9 +15,41 @@ The package exposes a single public entry point:
 import { ScheduleCore } from '@outbuild-company/schedule-core';
 ```
 
-Schedule Core owns domain state and mutations. Consumers send commands through
-`ScheduleCore.dispatch()` and translate the returned changes at their own UI
-and persistence boundaries.
+## Quick start
+
+```ts
+import {
+  COLUMN,
+  ScheduleCore,
+  type ScheduleCoreInput
+} from '@outbuild-company/schedule-core';
+
+const input: ScheduleCoreInput = getScheduleInput();
+const core = new ScheduleCore(input);
+await core.ready;
+
+const result = await core.dispatch({
+  kind: 'inline-edit',
+  activityId,
+  column: COLUMN.TEXT,
+  newValue: 'Updated activity'
+});
+
+if (!result.ok) throw new Error(result.reason);
+applyChangeSet(result.changes);
+
+core.destroy();
+```
+
+`getScheduleInput`, `activityId`, and `applyChangeSet` are consumer-provided
+values.
+
+Schedule Core owns domain state and mutations. Consumers provide normalized
+input, send commands through `dispatch()`, apply returned changes at the UI
+boundary, and persist them at the storage boundary.
+
+See the [complete API reference](docs/API.md) for initialization, every command,
+read APIs, persistence, history, critical path, helpers, constants, and types.
 
 ## Development