Merge branch 'beta' into #83-improve-batch-requests

Author: michaelwittwer

.commitlintrc.yml

@@ -0,0 +1,2 @@
+extends:
+  - "@commitlint/config-conventional"

.huskyrc.yml

@@ -0,0 +1,4 @@
+hooks:
+  commit-msg: "commitlint -E HUSKY_GIT_PARAMS"
+  pre-commit: "lint-staged"
+  pre-push: "npm run test && npm run build"

.lintstagedrc.yml

@@ -3,6 +3,13 @@ linters:
     - prettier --write --config ./.prettierrc.yml
     - tslint --project ./tsconfig.json -t codeFrame --fix
     - git add
+  "(src/**/*.spec.ts|test/**/*.ts)":
+    - prettier --write --config ./.prettierrc.yml
+    # FIXME tslint will not work because of the following error
+    # ✖ tslint --project ./tsconfig.jest.json -t codeFrame --fix found some errors. Please fix them and try committing again.
+    #'/Users/michaelwittwer/dev/shiftcode/dynamo-easy/test/models/complex.model.ts' is not included in project.
+    # - tslint --project ./tsconfig.jest.json -t codeFrame --fix
+    - git add
   "**/package.json":
     - sort-package-json
     - git add

.travis.yml

@@ -28,7 +28,7 @@ before_script: npx greenkeeper-lockfile-update
 
 script:
 - npm run lint:ci
-- npm run test:coverage
+- npm run test:ci
 - npm run build
 - npm run build:docs
 

README.md

@@ -8,12 +8,6 @@
 [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
 [![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg)](#contributors)
 
-This is the documentation for the new version of dynamo-easy released as a scoped package using the namespace 
-@shiftcoders (@shiftcoders/dynamo-easy). If you still want to use the 0.0.x version you can 
-by installing the old version `npm install dynamo-easy` (https://github
-.com/shiftcode/dynamo-easy/releases/tag/v0.10
-.1) 
-
 Abstracts away the complexity of the low level aws dynamosdk. Provides an easy to use fluent api to for requests and supports typescript decorators,
 to define some metadata for your models. You don't need to care about the mapping of javascript types to their dynamo types any more. We got you covered.
 
@@ -22,6 +16,53 @@ Checkout the full technical api documentation [here](https://shiftcode.github.io
 Built with :heart: by [shiftcode](https://www.shiftcode.ch).
 
 # Get Started
+
+## Prerequisite
+
+### Typescript Metadata
+
+#### Reflection API
+
+> ⚠ The reflect-metadata polyfill should be imported only once in your entire application because the Reflect object is 
+mean to be a global singleton.
+
+Install the reflect-metadata polyfill.
+
+```
+npm install reflect-metadata --save
+```
+
+The type definitions for reflect-metadata are included in the npm package. 
+You need to add the following reference to the types field in your [tsconfig.json](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html#types-typeroots-and-types):
+
+```
+"types": ["reflect-metadata"]
+```
+
+Finally, import reflect-metadata in some entry file in your application.
+
+```
+import "reflect-metadata"
+```
+
+#### Decorators
+
+
+We need to enable the two experimental features to work with decorators, add this to your tsconfig.json:
+
+```
+"experimentalDecorators": true
+"emitDecoratorMetadata": true
+```
+
+#### Other
+Also make sure to install the other peer dependencies of @shiftcoders/dynamo-easy.
+
+
+## First Sample
+
+When all the setup work is done, define your first model and create a dynamo store to execute actions on the dynamoDB.
+
 ```typescript
 @Model()
 class Person{
@@ -57,16 +98,9 @@ dynamoStore.scan()
 
 ```
 
-Want to use this library with Angular (>4) [checkout our angular-service](TODO).
-
 # Decorators
 Decorators are used to add some metadata to our model classes, relevant to our javascript-to-dynamo mapper.
 
-This is an experimental feature and requires to set the following typescript compiler options:
- 
-- "experimentalDecorators": true
-- "emitDecoratorMetadata": true
-
 Additionally we rely on the reflect-metadata (https://www.npmjs.com/package/reflect-metadata) library for reflection api.
 
 To get started with decorators just add a [@Model()](https://shiftcode.github.io/dynamo-easy/modules/_decorator_impl_model_model_decorator_.html) Decorator to any typescript class.