Skip to content

Commit a2c6221

Browse files
committed
docs: pin install to exact alpha.1 version, fix README wording
1 parent ebdb370 commit a2c6221

2 files changed

Lines changed: 11 additions & 6 deletions

File tree

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,19 @@ It is not production-ready yet. The goal right now is to keep the foundation sma
3939
Intent is available as experimental alpha packages on npm:
4040

4141
```sh
42-
pnpm add @intent-framework/core@alpha @intent-framework/dom@alpha @intent-framework/router@alpha @intent-framework/testing@alpha
42+
pnpm add @intent-framework/core@0.1.0-alpha.1 @intent-framework/dom@0.1.0-alpha.1 @intent-framework/router@0.1.0-alpha.1 @intent-framework/testing@0.1.0-alpha.1
4343
```
4444

4545
```sh
46-
npm install @intent-framework/core@alpha @intent-framework/dom@alpha @intent-framework/router@alpha @intent-framework/testing@alpha
46+
npm install @intent-framework/core@0.1.0-alpha.1 @intent-framework/dom@0.1.0-alpha.1 @intent-framework/router@0.1.0-alpha.1 @intent-framework/testing@0.1.0-alpha.1
4747
```
4848

49+
The quickstart pins the current alpha version so examples match the published APIs.
50+
4951
```txt
50-
First public alpha: v0.1.0-alpha.1
51-
GitHub Release: https://github.com/intent-framework/intent/releases/tag/v0.1.0-alpha.1
52+
Current alpha: v0.1.0-alpha.1
53+
First public alpha: v0.1.0-alpha.0
54+
GitHub Releases: https://github.com/intent-framework/intent/releases
5255
```
5356

5457
Published packages:

docs/Quickstart.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,17 @@ This guide shows the fastest path from zero to a semantic screen using published
77
## 1. Install
88

99
```sh
10-
pnpm add @intent-framework/core@alpha @intent-framework/dom@alpha @intent-framework/testing@alpha
10+
pnpm add @intent-framework/core@0.1.0-alpha.1 @intent-framework/dom@0.1.0-alpha.1 @intent-framework/testing@0.1.0-alpha.1
1111
```
1212

1313
Or with npm:
1414

1515
```sh
16-
npm install @intent-framework/core@alpha @intent-framework/dom@alpha @intent-framework/testing@alpha
16+
npm install @intent-framework/core@0.1.0-alpha.1 @intent-framework/dom@0.1.0-alpha.1 @intent-framework/testing@0.1.0-alpha.1
1717
```
1818

19+
The quickstart pins `0.1.0-alpha.1` so the examples match the APIs shown below.
20+
1921
You also need `typescript` and `vitest` for type checking and tests.
2022

2123
The router (`@intent-framework/router`) and server (`@intent-framework/server`) are separate — the quickstart stays screen-first.

0 commit comments

Comments
 (0)