README/package tweaks

Author: Brendan Abbott

.editorconfig

@@ -3,4 +3,6 @@ root = true
 [*]
 indent_style = space
 indent_size = 2
-insert_final_newline = true
+insert_final_newline = true
+trim_trailing_whitespace = true
+charset = "utf-8"

README.md

@@ -1,13 +1,12 @@
+# Serverless OpenAPI Documentation Plugin
 
+[![NPM](https://img.shields.io/npm/v/serverless-openapi-documentation.svg)](https://npmjs.org/packages/serverless-openapi-documentation/)
 [![Travis CI](https://img.shields.io/travis/temando/serverless-openapi-documentation.svg)](https://travis-ci.org/temando/serverless-openapi-documentation)
 [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 
-
-# Serverless OpenAPI Documentation Plugin
-
 Generates [**OpenAPI 3.0 RC2**](https://github.com/OAI/OpenAPI-Specification/tree/OpenAPI.next) documentation from serverless configuration files. OpenAPI is formerly known as Swagger. The configuration is inspired by the format used in [serverless-aws-documentation](https://www.npmjs.com/package/serverless-aws-documentation).
 
-Works well on [Lincoln Open Api Renderer](https://github.com/temando/open-api-renderer)
+Works well with [Lincoln Open Api Renderer](https://github.com/temando/open-api-renderer).
 
 ---
 
@@ -170,7 +169,7 @@ functions:
           cookieParams:
             - name: "SessionId"
               description: "A Session ID variable"
-              schema: 
+              schema:
                 type: "string"
           methodResponses:
             - statusCode: 201
@@ -261,7 +260,7 @@ methodResponse:
         description: "Content Type header"
         schema:
           type: "string"
-    responseModels: 
+    responseModels:
       application/json: "CreateResponse"
       application/xml: "CreateResponseXML"
 ```
@@ -334,7 +333,6 @@ serverless | grep "ServerlessOpenAPIDocumentation"
 
 It should return `ServerlessOpenAPIDocumentation` as one of the plugins on the list.
 
-
 ## License
 
 MIT

package.json

@@ -3,17 +3,28 @@
   "version": "0.2.0",
   "description": "Serverless 1.0 plugin to generate OpenAPI V3 documentation from serverless configuration",
   "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/temando/serverless-openapi-documentation.git"
+  },
+  "bugs": "https://github.com/temando/serverless-openapi-documentation/issues",
   "author": "Abilio Henrique <[email protected]>",
   "contributors": [
     "Abilio Henrique <[email protected]>",
     "nfour <[email protected]>"
   ],
+  "keywords":[
+    "OpenAPI",
+    "swagger",
+    "serverless"
+  ],
   "license": "MIT",
   "scripts": {
     "test": "jest",
     "test:build": "jest -c '{}' build",
     "test:coverage": "jest --coverage",
     "lint": "tslint 'src/**/*.ts'",
+    "preversion": "npm run lint && npm run test",
     "release": "cd build && npm publish",
     "test:project": "cd test/project && yarn sls openapi generate",
     "test:prepare": "scripts/prepareTests.bash",