Skip to content

Commit

Permalink
documentation update for serverless plugin manager install
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremydaly committed Oct 20, 2017
1 parent 9c569fa commit a5db4db
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
# serverless-stage-manager
Super simple [serverless](http://www.serverless.com) plugin for validating stage names before deployment.

[![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com)
[![Serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com)
[![npm](https://img.shields.io/npm/v/serverless-stage-manager.svg)](https://www.npmjs.com/package/serverless-stage-manager)
[![npm](https://img.shields.io/npm/l/serverless-stage-manager.svg)](https://www.npmjs.com/package/serverless-stage-manager)

## Installation & Configuration
## Installation

#### Install using Serverless plugin manager
```bash
serverless plugin install --name serverless-stage-manager
```

#### Install using npm

Install the module using npm:
```bash
Expand All @@ -19,6 +26,8 @@ plugins:
- serverless-stage-manager
```
## Configuration
Add a `stages` value in the `custom` section of your `serverless.yml` file and specify an array of valid stage names.

```yaml
Expand All @@ -34,9 +43,13 @@ custom:
When running `serverless deploy` or `serverless deploy function`, it will check to make sure it is a valid stage name before continuing. For example:

```bash
# Given the above configuration of dev, staging & prod
# These will work
serverless deploy -s prod
serverless deploy -s staging
serverless deploy functon -f funcName -s dev
serverless deploy # assuming default stage is in custom.stages config
# These will fail
serverless deploy -s foo
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "serverless-stage-manager",
"version": "1.0.2",
"version": "1.0.3",
"description": "Super simple serverless plugin for validating stage names before deployment",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit a5db4db

Please sign in to comment.