Skip to content

Commit 25d2a74

Browse files
author
jay
committed
fix: README.md
1 parent 0caf037 commit 25d2a74

1 file changed

Lines changed: 13 additions & 15 deletions

File tree

README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,20 @@ patches. The server binds to `127.0.0.1` and keeps backups under
77

88
## Usage
99

10-
Published to the public npm registry — no login, no token, no registry
11-
configuration:
10+
GitHub Packages requires authentication even when consuming a public package.
11+
Point the `@deckflow` scope at GitHub Packages and log in with a GitHub personal
12+
access token (classic) that has `read:packages` permission:
1213

1314
```bash
14-
npx @deckflow/html-editor ./index.html
15+
npm config set @deckflow:registry https://npm.pkg.github.com
16+
npm login --scope=@deckflow --auth-type=legacy --registry=https://npm.pkg.github.com
1517
```
1618

17-
> Earlier versions were published to GitHub Packages, which requires a token
18-
> even to read a public package. If you configured `@deckflow:registry` for
19-
> that, remove it — it will otherwise shadow this package and every other
20-
> `@deckflow` one:
21-
>
22-
> ```bash
23-
> npm config delete @deckflow:registry
24-
> ```
19+
Then run the package directly:
20+
21+
```bash
22+
npx @deckflow/html-editor ./index.html
23+
```
2524

2625
## Global CLI
2726

@@ -213,13 +212,12 @@ editable, but changing their grid safely requires a span-aware table model.
213212

214213
Publishing is handled by [`.github/workflows/publish.yml`](.github/workflows/publish.yml).
215214
Creating a GitHub Release runs the test suite, checks the package contents, and
216-
publishes the matching version to the public npm registry with provenance. A
215+
publishes the matching version to GitHub Packages. A
217216
release tagged `v0.1.1` (or `0.1.1`) must therefore contain `"version":
218217
"0.1.1"` in `package.json`.
219218

220-
The workflow needs one repository secret, `NPM_TOKEN` — an npm automation token
221-
with publish rights on the `@deckflow` scope. The built-in `GITHUB_TOKEN`
222-
cannot publish to npmjs; it only ever authenticated against GitHub Packages.
219+
The workflow grants `packages: write` to the repository's built-in
220+
`GITHUB_TOKEN`, so no npm token or additional Actions secret is required.
223221

224222
A normal patch release can be prepared with:
225223

0 commit comments

Comments
 (0)