@clipmx/lambda-utils - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "@clipmx/lambda-utils",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Common helpers for Node Lambdas",
@@ -16,3 +16,3 @@ "main": "lib/index.js",
     "start": "npm run build -- -w",
-    "prepublishOnly": "npm run test && npm run build",
+    "prepublishOnly": "npm run build",
     "clean": "rm -rf node_modules && npm install"
@@ -19,0 +19,0 @@ },

README.md

@@ -1,2 +0,2 @@
-# Lambda Utils
+# Node Lambda Utils
 
@@ -7,2 +7,39 @@ ## Installation
 npm install @clipmx/lambda-utils
-```
+```
+
+## Usage
+
+Refer to the [API docs](http://github.clip.mx/node.lambda-utils/) for usage examples
+
+## Technologies Used
+
+* [TypeScript](https://www.typescriptlang.org/docs/home.html)
+* [Jest](https://facebook.github.io/jest/) for testing
+* [Sinon](http://sinonjs.org/) for test mocks
+* [TypeDoc](http://typedoc.org/) for auto-generated documentation
+
+## Contributing
+
+Anything that is reusable in our Node Lambdas would be a good addition to this library.
+
+```
+git clone [e-mail]:ClipMX/node.lambda-utils.git
+```
+
+**Build Tests**
+
+```
+npm run test:watch
+```
+
+**Add Usage Examples**
+
+TypeDoc will generate API documentation based on the TypeScript types used in the code. TypeDoc will also
+pull any doc strings into the generated code, which is useful for providing a little more description and
+usage examples to each `Module`, `Class`, `Variable`, `Function`, etc. The doc string should be written in
+MarkDown to take advantage of syntax highlighted code blocks.
+
+## TypeScript Resources
+
+* [TypeScript Deep Dive](https://basarat.gitbooks.io/typescript/content/docs/getting-started.html)
+* [TypeScript Docs](https://www.typescriptlang.org/docs/home.html)

No alert changes

Improved metrics

Total package byte prevSize

48434

increased by2.43%

Number of lines in readme file

44

increased by528.57%

No dependency changes