|
2 | 2 | [](https://www.npmjs.com/package/localforage-cordovasqlitedriver) |
3 | 3 | SQLite driver for [Cordova](https://cordova.apache.org/) apps using [localForage](https://github.com/mozilla/localForage). |
4 | 4 |
|
5 | | -## upgrade warning |
6 | | - |
7 | | -v1.2 *BREAKING CHANGE* |
8 | | -The default storage location for SQLite has changed in newer versions of [Cordova SQLite storage plugin](https://github.com/litehelpers/Cordova-sqlite-storage/). |
9 | | - |
10 | | -*WARNING*: The new "default" location value is NOT the same as the old default location and would break an upgrade for an app that was using the old default value (0) on iOS. |
11 | | - |
12 | | -If you are upgrading to a newer version of `localForage-cordovaSQLiteDriver` you need to verify where your previous storage location was and update the `location` property of the localForage database. Otherwise the default is `'default'`. This is to avoid breaking the iCloud Design Guide. See [here](https://github.com/litehelpers/Cordova-sqlite-storage#important-icloud-backup-of-sqlite-database-is-not-allowed) for further details. |
13 | | - |
14 | | -## requirements |
| 5 | +## Requirements |
15 | 6 |
|
16 | 7 | * [Cordova](https://cordova.apache.org/)/[ionic](http://ionicframework.com/) |
17 | 8 | * [Cordova SQLite storage plugin](https://github.com/litehelpers/Cordova-sqlite-storage/) |
18 | | -* [localForage](https://github.com/mozilla/localForage) v1.1.1+ |
| 9 | +* [localForage](https://github.com/mozilla/localForage) v1.4.0+ |
| 10 | + * for earlier versions of localforage, please use the v1.2.x releases |
19 | 11 |
|
20 | | -## install dependencies |
| 12 | +## Install Dependencies |
21 | 13 |
|
22 | 14 | * install Cordova-sqlite-storage plugin `cordova plugin add https://github.com/litehelpers/Cordova-sqlite-storage.git` |
23 | 15 | * install localForage-cordovaSQLiteDriver `bower install --save localForage-cordovaSQLiteDriver` |
24 | 16 |
|
25 | | -## setup your project |
| 17 | +## CHANGELOG |
| 18 | + |
| 19 | +### v1.3 |
| 20 | +Reduce driver size (almost by 50%) by "inheriting" the method implementations of the `localforage.WEBSQL` driver. |
| 21 | + |
| 22 | +### v1.2 *BREAKING CHANGE* |
| 23 | +Add support for newer versions of [Cordova SQLite storage plugin](https://github.com/litehelpers/Cordova-sqlite-storage/) (v0.8.x & v1.2.x). |
| 24 | + |
| 25 | +*UPGRADE WARNING*: The default storage location for SQLite has changed in newer versions of [Cordova SQLite storage plugin](https://github.com/litehelpers/Cordova-sqlite-storage/). The new "`default`" location value is NOT the same as the old "`default`" location and will break an upgrade for an app that was using the old default value (0) on iOS. If you are upgrading to a newer version of `localForage-cordovaSQLiteDriver` you need to verify where your previous storage location was and update the `location` property of the localForage database. Otherwise the default is `'default'`. This is to avoid breaking the iCloud Design Guide. See [here](https://github.com/litehelpers/Cordova-sqlite-storage#important-icloud-backup-of-sqlite-database-is-not-allowed) for further details. |
| 26 | + |
| 27 | +### v1.1 |
| 28 | +Try using the `getSerializer()` (available in localforage v1.3) as the prefered way to retrieve the serializer. |
| 29 | + |
| 30 | +## Setup Your Project |
26 | 31 |
|
27 | 32 | * Include localforage and localForage-cordovaSQLiteDriver in your main html page, after the cordova include. |
28 | 33 | * Call `defineDriver` and `setDriver` to make localForage use the cordovaSQLiteDriver. |
|
0 commit comments