Skip to content

Commit 7bd9eb6

Browse files
committed
chore: updated readme to reference local quickstart
1 parent 9a6a2d2 commit 7bd9eb6

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,14 @@
1616

1717
### Quick Starts
1818

19+
#### Local
20+
21+
You can quickly get started by installing/executing `vsr` with the following command:
22+
23+
```bash
24+
npx -y vltpkg/vsr
25+
```
26+
1927
#### Production
2028

2129
You can deploy `vsr` to [Cloudflare](https://www.cloudflare.com/) in under 5 minutes, for free, with a single click (coming soon).
@@ -223,7 +231,7 @@ A `scope` contains an array of privileges that define both the type(s) of & acce
223231

224232
### API
225233

226-
We have rich, interactive API docs out-of-the-box with the help of our friends [Scalar](https://scalar.com/). The docs can be found at the registry root when running `vsr` locally (ex. run `npx vltpkg/vsr` &/or check out this repo & run `npm run dev`)
234+
We have rich, interactive API docs out-of-the-box with the help of our friends [Scalar](https://scalar.com/). The docs can be found at the registry root when running `vsr` locally (ex. run `npx -y vltpkg/vsr` &/or check out this repo & run `npm run dev`)
227235

228236
### `npm` Client Compatibility
229237

0 commit comments

Comments
 (0)