Skip to content

Commit

Permalink
chore: updated readme to reference local quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
darcyclarke committed Nov 11, 2024
1 parent 9a6a2d2 commit 7bd9eb6
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,14 @@

### Quick Starts

#### Local

You can quickly get started by installing/executing `vsr` with the following command:

```bash
npx -y vltpkg/vsr
```

#### Production

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

### API

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`)
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`)

### `npm` Client Compatibility

Expand Down

0 comments on commit 7bd9eb6

Please sign in to comment.