Skip to content

Commit 336f4ec

Browse files
committed
Document the experimental npm channel
1 parent 8d0836a commit 336f4ec

2 files changed

Lines changed: 28 additions & 0 deletions

File tree

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,24 @@ metta-ts path/to/program.metta
3636
npx -p @metta-ts/node metta-ts path/to/program.metta
3737
```
3838

39+
### Experimental channel
40+
41+
A prerelease line ships ahead of stable on the `experimental` npm dist-tag. It
42+
carries the in-progress Minimal MeTTa runtime and the Grounded V2 operation
43+
protocol: owned, pull-based answer streams with per-answer binding deltas and
44+
effects, and `MeTTa.registerStreamingOperation` on the runner. Opt in per package
45+
with the tag:
46+
47+
```bash
48+
npm install @metta-ts/core@experimental
49+
npm install @metta-ts/hyperon@experimental
50+
```
51+
52+
A plain `npm install @metta-ts/core` stays on the stable `latest` tag. The
53+
experimental surface may still change before it lands in a stable release; see the
54+
[`experimental` branch](https://github.com/MesTTo/MeTTa-TS/tree/experimental) and
55+
the [1.2.0-experimental.0 notes](https://github.com/MesTTo/MeTTa-TS/releases/tag/v1.2.0-experimental.0).
56+
3957
## Quick start
4058

4159
Run MeTTa source from TypeScript with the core package:

website/guide/getting-started.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,16 @@ For the command-line runner, install `@metta-ts/node`:
2222
npm install -g @metta-ts/node
2323
```
2424

25+
### Experimental channel
26+
27+
A prerelease line ships ahead of stable on the `experimental` npm dist-tag, with the in-progress Minimal MeTTa runtime and the Grounded V2 operation protocol (owned, pull-based grounded answer streams with per-answer binding deltas and effects, and `MeTTa.registerStreamingOperation`). Opt in with the tag:
28+
29+
```bash
30+
npm install @metta-ts/core@experimental
31+
```
32+
33+
A plain `npm install @metta-ts/core` stays on the stable `latest` tag. The experimental surface may still change before it reaches a stable release.
34+
2535
## Your first program
2636

2737
Here is a small MeTTa program. Press **Run** to evaluate it in your browser, or save it as `hello.metta` to run from the command line:

0 commit comments

Comments
 (0)