@@ -4,7 +4,10 @@ While the `node-sqlite3` project does include support for compiling against sqlc
44
55## Supported platforms
66
7- Tested on Node v8.x and Electron 1.7.9, on Windows, Mac and Linux.
7+ Tests are run and pre-built binaries are made available for the following platforms:
8+ * Node 8, 10 and 12.
9+ * Electron 3, 4 and 5.
10+ * Windows, Mac and Linux.
811
912# Requirements
1013
@@ -15,7 +18,7 @@ Tested on Node v8.x and Electron 1.7.9, on Windows, Mac and Linux.
1518
1619### Mac
1720
18- * ` brew install openssl `
21+ * ` brew install openssl@1.1 `
1922
2023# Installation
2124
@@ -33,6 +36,9 @@ var sqlite3 = require('@journeyapps/sqlcipher').verbose();
3336var db = new sqlite3.Database (' test.db' );
3437
3538db .serialize (function () {
39+ // Required to open a database created with SQLCipher 3.x
40+ db .run (" PRAGMA cipher_compatibility = 3" );
41+
3642 db .run (" PRAGMA key = 'mysecret'" );
3743 db .run (" CREATE TABLE lorem (info TEXT)" );
3844
@@ -52,7 +58,7 @@ db.close();
5258
5359# SQLCipher
5460
55- A copy of the source for SQLCipher 4.0.1 is bundled, which is based on SQLite 3.26 .0.
61+ A copy of the source for SQLCipher 4.2.0 is bundled, which is based on SQLite 3.28 .0.
5662
5763## OpenSSL
5864
@@ -68,13 +74,15 @@ On Linux we dynamically link against the system OpenSSL.
6874
6975See the [ API documentation] ( https://github.com/mapbox/node-sqlite3/wiki ) in the wiki.
7076
77+ Documentation for the SQLCipher extension is available [ here] ( https://www.zetetic.net/sqlcipher/sqlcipher-api/ ) .
78+
7179# Testing
7280
7381[ mocha] ( https://github.com/visionmedia/mocha ) is required to run unit tests.
7482
7583In sqlite3's directory (where its ` package.json ` resides) run the following:
7684
77- npm install mocha
85+ npm install --build-from-source
7886 npm test
7987
8088# Publishing
@@ -94,4 +102,8 @@ Additionally, some of the SQLCipher-related changes are based on a fork by [liub
94102
95103# License
96104
97- ` node-sqlcipher ` is [ BSD licensed] ( https://github.com/mapbox/node-sqlite3/raw/master/LICENSE ) .
105+ ` node-sqlcipher ` is [ BSD licensed] ( ./LICENSE ) .
106+
107+ ` SQLCipher ` is ` Copyright (c) 2016, ZETETIC LLC ` under the [ BSD license] ( https://github.com/sqlcipher/sqlcipher/blob/master/LICENSE ) .
108+
109+ ` SQLite ` is Public Domain
0 commit comments