Skip to content

Commit 5690c82

Browse files
romearaEnase
authored andcommitted
Clarify install for less-experienced npm users
The serverless framework makes use of npm, but is designed to allow deployment to services such as AWS which support a variety of languages. As a result, there are users utilizing the serverless tool who are not as familiar with npm commands. This change adds the explicit command syntax needed to accomplish the installation to the README install instructions
1 parent f7d8446 commit 5690c82

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,20 @@ protecting the aliased function versions, and many more.
2828
## Installation
2929

3030
Add the plugin to your package.json's devDependencies and to the plugins array
31-
in your `serverless.yml` file. After installation the plugin will automatically
32-
hook into the deployment process.
33-
Additionally the new `alias` command is added to Serverless which offers some
34-
functionality for aliases.
31+
in your `serverless.yml` file
32+
33+
Terminal:
34+
```
35+
npm install --save-dev serverless-aws-alias
36+
```
37+
38+
serverless.yml:
39+
```
40+
plugins:
41+
- serverless-aws-alias
42+
```
43+
44+
After installation the plugin will automatically hook into the deployment process. Additionally the new `alias` command is added to Serverless which offers some functionality for aliases.
3545

3646
## Deploy the default alias
3747

0 commit comments

Comments
 (0)