diff --git a/README.md b/README.md index 5dfa01e..315bc46 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Plugin for Serverless Framework v1.x which compares your local AWS CloudFormation templates against deployed ones. -## Usage +# Usage ```bash serverless deploy diff --stage REPLACEME --region REPLACEME @@ -16,7 +16,26 @@ serverless deploy diff --stage REPLACEME --region REPLACEME screen shot 2016-11-05 at 14 53 04 -## Install +## Command options + +```bash +--diffTool ksdiff +``` + +Custom diff tool: + +>Defaults to `diff` + + +```bash +--localTemplate foo.json +``` + +Custom CloudFormation template to diff against: + +>Defaults to `./serverless/cloudformation-template-update-stack.json` + +# Install Execute npm install in your Serverless project. diff --git a/lib/index.js b/lib/index.js index 94db6b7..2c56e69 100644 --- a/lib/index.js +++ b/lib/index.js @@ -12,7 +12,7 @@ class ServerlessPlugin { this.commands = { diff: { - usage: 'Compares locale AWS CloudFormation templates against deployed ones', + usage: 'Compares local AWS CloudFormation templates against deployed ones', lifecycleEvents: ['diff'], options: { diffTool: { diff --git a/package.json b/package.json index 00b0aee..ba1aa0a 100644 --- a/package.json +++ b/package.json @@ -18,6 +18,14 @@ "repository": { "git": "https://github.com/nicka/serverless-plugin-diff" }, + "homepage": "https://github.com/nicka/serverless-plugin-diff", + "keywords": [ + "aws", + "diff", + "lambda", + "plugin", + "serverless" + ], "dependencies": { "aws-sdk": "^2.6.15", "child-process-promise": "^2.2.0",