Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: use webSqlDriver methods to reduce the implementation #8

Merged
merged 6 commits into from
Apr 19, 2016
Merged

feat: use webSqlDriver methods to reduce the implementation #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a12721d
refactor: reduce code by using only localForage v1.3 getSerializer() …
thgreasi Apr 16, 2016
860783e
feat: use webSqlDriver methods to reduce the implementation
thgreasi Apr 17, 2016
dae227e
chore(bower.json): update minimum required localforage version
thgreasi Apr 17, 2016
e6eb497
docs(README): update minimum required localforage version
thgreasi Apr 17, 2016
e90321e
docs(README): add dedicated CHANGELOG section
thgreasi Apr 18, 2016
a1cbd7e
chore: increase version number to v1.3
thgreasi Apr 18, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 18 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,32 @@
[![npm](https://img.shields.io/npm/dm/localforage-cordovasqlitedriver.svg)](https://www.npmjs.com/package/localforage-cordovasqlitedriver)
SQLite driver for [Cordova](https://cordova.apache.org/) apps using [localForage](https://github.com/mozilla/localForage).

## upgrade warning

v1.2 *BREAKING CHANGE*
The default storage location for SQLite has changed in newer versions of [Cordova SQLite storage plugin](https://github.com/litehelpers/Cordova-sqlite-storage/).

*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.

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.

## requirements
## Requirements

* [Cordova](https://cordova.apache.org/)/[ionic](http://ionicframework.com/)
* [Cordova SQLite storage plugin](https://github.com/litehelpers/Cordova-sqlite-storage/)
* [localForage](https://github.com/mozilla/localForage) v1.1.1+
* [localForage](https://github.com/mozilla/localForage) v1.4.0+
* for earlier versions of localforage, please use the v1.2.x releases

## install dependencies
## Install Dependencies

* install Cordova-sqlite-storage plugin `cordova plugin add https://github.com/litehelpers/Cordova-sqlite-storage.git`
* install localForage-cordovaSQLiteDriver `bower install --save localForage-cordovaSQLiteDriver`

## setup your project
## CHANGELOG

### v1.3
Reduce driver size (almost by 50%) by "inheriting" the method implementations of the `localforage.WEBSQL` driver.

### v1.2 *BREAKING CHANGE*
Add support for newer versions of [Cordova SQLite storage plugin](https://github.com/litehelpers/Cordova-sqlite-storage/) (v0.8.x & v1.2.x).

*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.

### v1.1
Try using the `getSerializer()` (available in localforage v1.3) as the prefered way to retrieve the serializer.

## Setup Your Project

* Include localforage and localForage-cordovaSQLiteDriver in your main html page, after the cordova include.
* Call `defineDriver` and `setDriver` to make localForage use the cordovaSQLiteDriver.
Expand Down
4 changes: 2 additions & 2 deletions bower.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "localforage-cordovasqlitedriver",
"version": "1.2.1",
"version": "1.3.0",
"main": [
"src/localforage-cordovasqlitedriver.js"
],
Expand All @@ -18,7 +18,7 @@
"site*"
],
"dependencies": {
"localforage": "^1.2.1"
"localforage": "^1.4.0"
},
"devDependencies": {
"es6-promise": "~1.0.0",
Expand Down
2 changes: 1 addition & 1 deletion component.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "localForage-cordovaSQLiteDriver",
"version": "1.2.1",
"version": "1.3.0",
"dependencies": {
"then/promise": "5.0.0"
},
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"driver",
"cordova"
],
"version": "1.2.1",
"version": "1.3.0",
"homepage": "https://github.com/thgreasi/localForage-cordovaSQLiteDriver",
"repository": {
"type": "git",
Expand Down
Loading