improved README to example changed for TypeORM 0.1.8

daniel-lang · daniel-lang · commit 8be1b228f680 · 2017-11-30T22:08:21.000+01:00
diff --git a/README.md b/README.md
@@ -2,6 +2,24 @@
 You can use TypeORM in connection with the `cordova-sqlite-storage` plugin in your Ionic app.
 This project demonstrates how that would work.
 
+## TypeORM >= 0.1.8
+To support webpack builds outside of Ionic we had to remove the automatic selection of the correct TypeORM version (the `typeorm` package comes with a Node and a browser version). In order to keep using TypeORM with Ionic you have to create a custom `webpack.config.js` file. This example contains one that is identical to the one Ionic uses when no config file is specified but adds the `NormalModuleReplacementPlugin` to select the correct version.
+If you already have a custom webpack config file you have to add these lines to your plugins (for both development and production):
+```js
+plugins: [
+  ...,
+  new webpack.NormalModuleReplacementPlugin(/typeorm$/, function (result) {
+    result.request = result.request.replace(/typeorm/, "typeorm/browser");
+  })
+]
+```
+If you don't use a custom wepack config, copy the one from this example and add it to your `package.json` under `config`:
+```json
+"config": {
+  "ionic_webpack": "./config/webpack.config.js"
+}
+``` 
+
 ### How to run this example
 1. Install the ionic and cordova cli: `npm install -g cordova ionic`
 2. Install all dependencies: `npm install`
