Skip to content

docs(cli): prefer scoped npm install command #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
skulidropek merged 1 commit into from
Mar 21, 2026
Merged

docs(cli): prefer scoped npm install command #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,14 @@ and then writes project-specific runtime files.

## Usage

Until the npm package is published, run it directly from GitHub:

```bash
npx --yes github:SpawnDock/create-spawn-dock#main --token <pairing-token> [project-dir]
npx @spawn-dock/create-spawn-dock --token <pairing-token> [project-dir]
```

After npm publish, the intended short form remains:
If npm registry access is unavailable, the GitHub fallback remains:

```bash
npx @spawn-dock/create-spawn-dock --token <pairing-token> [project-dir]
npx --yes github:SpawnDock/create-spawn-dock#main --token <pairing-token> [project-dir]
```

## What it writes
Expand Down