Update README prior to publish

temyers · temyers · commit e9436187764b · 2018-01-10T08:03:22.000+08:00
diff --git a/.travis.yml b/.travis.yml
@@ -14,4 +14,4 @@ script:
   # setup links for integration testing
   - npm link
   # FIXME - integration test fails first time, due to timing issue - S3 bucket does not exist after initial create stack completes.
-  - npm run integ || npm run integ || npm run integ
+  - npm run test:integration || npm run test:integration || npm run test:integration
diff --git a/README.md b/README.md
@@ -158,9 +158,11 @@ git clone https://github.com/temyers/serverless-localstack
 ##### Setup your project
 
 ```
+cd /path/to/serverless-localstack
+npm link
+
 cd myproject
-mkdir .serverless_plugins
-ln -s /absolute/path/to/serverless-localstack .serverless_plugins/serverless-localstack
+npm link serverless-localstack
 ```
 
 ### Optional Debug Flag
@@ -172,3 +174,13 @@ custom:
   localstack:
     debug: true
 ```
+
+## Publishing to NPM
+
+```
+yarn install
+yarn version
+npm login
+npm publish
+
+```
diff --git a/package.json b/package.json
@@ -8,9 +8,11 @@
     "lint-fix": "eslint . --fix",
     "test": "jasmine --config=spec/support/jasmine.json",
     "test:watch": "jasmine --config=spec/support/jasmine.json",
-    "integ": "jasmine --config=spec/support/jasmine_integration.json",
-    "integ:watch": "nodemon -L -i spec/integrate ./node_modules/.bin/jasmine --config=spec/support/jasmine_integration.json",
-    "test:cover": "jasmine --coverage"
+    "test:integration": "jasmine --config=spec/support/jasmine_integration.json",
+    "test:integration:watch": "nodemon -L -i spec/integrate ./node_modules/.bin/jasmine --config=spec/support/jasmine_integration.json",
+    "test:cover": "jasmine --coverage",
+    "prepublish": "yarn run test",
+    "preversion": "yarn run test"
   },
   "repository": {
     "type": "git",
diff --git a/yarn.lock b/yarn.lock
