Skip to content

Commit

Permalink
Merge pull request #1828 from brefphp/fix-links-sls-v4
Browse files Browse the repository at this point in the history
Fix documentation links for Serverless v3
  • Loading branch information
mnapoli committed Jun 18, 2024
2 parents be276f2 + 71d3d79 commit 71765be
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions docs/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,15 @@ To use Bref, you will need an AWS account and the `serverless` CLI. Let's get st

### Serverless CLI

Bref relies on the [Serverless framework](https://serverless.com/) and AWS access keys to deploy applications. You will need to install the `serverless` CLI ([more details here](https://serverless.com/framework/docs/providers/aws/guide/quick-start/)):
Bref relies on the [Serverless framework](https://serverless.com/) and AWS access keys to deploy applications. You will need to install the `serverless` CLI using NPM:

```bash
npm install -g serverless@3
```

Bref is compatible with Serverless Framework v3 (current stable version).
Bref is compatible with Serverless Framework v3 and v4. However the Bref documentation is written for v3 as v4 switches to a proprietary license.

<Callout type="warning">
Serverless Framework v4 is currently in beta and switches to a proprietary license. Running `npm install -g serverless` will install v4. To install v3, run `npm install -g serverless@3`.
</Callout>
If you don't want to install `serverless` via NPM, you can install it as a standalone binary [by following this documentation](https://github.com/serverless/serverless/blob/v3/docs/install-standalone.md).

### AWS credentials

Expand Down

0 comments on commit 71765be

Please sign in to comment.