Fixed typo, updated package.json and README.md

nicka · Nov 9, 2016 · db542b1 · db542b1
1 parent 9d95c79
commit db542b1
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -8,15 +8,34 @@
 
 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
 ```
 
 <img width="1255" alt="screen shot 2016-11-05 at 14 53 04" src="https://cloud.githubusercontent.com/assets/195404/20030536/9e1a552c-a367-11e6-8e6d-2043f2a5d038.png">
 
-## 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
@@ -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
@@ -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",