Update documentation

Author: ollwells

projects/ionic-typeorm/README.md

@@ -2,15 +2,15 @@
 
 ## Installation
 
-Follow [install steps](installs.md) for installing `@rareloop/ionic-typeorm`
+Follow [install steps](./docs/install.md) for installing `@rareloop/ionic-typeorm`
 
 An example Ionic project can be found [in the example project](../example/README.md)
 
 </br>
 
 ## Testing
 
-Follow [unit testing config](./installs.md) for additional changes to allow karma to run unit tests with `typeorm`
+Follow [unit testing config](./docs/testing.md) for additional changes to allow karma to run unit tests with `typeorm`
 
 </br>
 
@@ -136,7 +136,7 @@ export interface IDBService<T extends BaseEntity> {
 
 </br>
 
-## Migrations
+## Auto-Migrations
 
 Add the following npm scripts to provide migration commands.
 

projects/ionic-typeorm/docs/install.md

@@ -1,16 +1,19 @@
 # Ionic Typeorm Installation
 
+Install the library and it's dependencies.
+
 ``` sh
 npm install --save @rareloop/ionic-typeorm
 ```
 
-Install peer dependencies
-
 ``` sh
 npm install --save typeorm sql.js
 npm install --save-dev @angular-builders/custom-webpack
 ```
 
+To allow the `typeorm` entity decorations we require an extra compiler option.
+We also fix a bug where `react-native-sqlite-storage` is not defined by pointing it at a shim.
+
 In `tsconfig.json`:
 
 ``` json
@@ -23,6 +26,8 @@ In `tsconfig.json`:
     },
 ```
 
+Update the tsconfig to use `node` types and to include our shim file.
+
 and `tsconfig.app.json`
 
 ``` json
@@ -43,6 +48,8 @@ and `tsconfig.app.json`
 }
 ```
 
+In order to build `typeorm` correctly we require a `custom-webpack` builder so update the `angular.json` to do this.
+
 In `angular.json`
 
 ``` json
@@ -72,12 +79,3 @@ In `angular.json`
         }
     }
 ```
-
-Add the following scripts for use for migrations
-
-``` JSON
-    "scripts": {
-        "migration:create": "npx ionic-typeorm-create",
-        "migration:generate": "npx ionic-typeorm-generate"
-    }
-```

projects/ionic-typeorm/docs/testing.md

@@ -1,5 +1,7 @@
 # Ionic Typeorm Testing Configuration
 
+An issue with `sql.js:1.5.0` means it doesn't work nicely with karma. In order to work around this an older copy of `sql.js` is included instead for unit testing.
+
 For unit tests: `karma.conf.js`
 
 ``` javascript

projects/ionic-typeorm/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rareloop/ionic-typeorm",
-    "version": "0.0.16",
+    "version": "0.0.17",
     "description": "",
     "license": "MIT",
     "author": "Rareloop",