Skip to content

Commit

Permalink
Update package docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AndrewBarba committed Jan 24, 2023
1 parent 6c9dbcb commit 6c82044
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,19 +89,21 @@ vercel link
After linking your project you can deploy it via Swift package manager:

```bash
swift package --disable-sandbox vercel
swift package --disable-sandbox vercel --deploy
```

### Deploy Options

```bash
swift package --disable-sandbox vercel --product MyApp --memory 1024 --duration 60 --regions iad1,sfo1
swift package --disable-sandbox vercel
```

- `--product` - The product you want to deploy. Default: first target in Package.swift with the Vercel dependency
- `--memory` - The amount of memory in megabytes to allocate to your function. Default 512mb
- `--duration` - The maximum duration in seconds that your function will run. Default: 10s
- `--regions` - Comma separated list of regions to deploy your function to. Default: iad1
- `--deploy` - Triggers a deploy to Vercel
- `--prod` - Triggers a production deploy to Vercel
- `--product <name>` - The product you want to build. Default: first target in Package.swift with the Vercel dependency
- `--memory <number>` - The amount of memory in megabytes to allocate to your function. Default 512mb
- `--duration <number>` - The maximum duration in seconds that your function will run. Default: 10s
- `--regions <name>` - Comma separated list of regions to deploy your function to. Default: iad1

### GitHub Actions

Expand Down Expand Up @@ -143,5 +145,5 @@ jobs:
run: npm install -g vercel@latest

- name: Deploy
run: swift package --disable-sandbox vercel --prod
run: swift package --disable-sandbox vercel --deploy --prod
```

0 comments on commit 6c82044

Please sign in to comment.