@trailstep/core 0.1.1 → 0.3.0

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.
package/README.md CHANGED
@@ -28,6 +28,17 @@ TrailStep's key runtime boundary is the step: each step can run as a focused uni
28
28
 
29
29
  Runtime events are appended to `.trailstep/runs/<runName>/events.jsonl` by default. Set `TRAILSTEP_RUNS_ROOT` in CLI runs when you need artifacts somewhere else. Run directories are generated outputs for inspection and replay; do not manually edit them to recover workflow state.
30
30
 
31
+ ## Provider package export convention
32
+
33
+ Provider packages expose their definition from the package root as an ESM export named `trailstepProvider`. The exported object must include a serializable `manifest`; optional hook functions belong beside the manifest, not inside it:
34
+
35
+ ```ts
36
+ export const trailstepProvider = {
37
+ manifest: { schemaVersion: 1, id: "example", /* ... */ },
38
+ hooks: { /* optional hook functions */ },
39
+ };
40
+ ```
41
+
31
42
  ## More docs
32
43
 
33
44
  - [Architecture](../../docs/architecture.md)