Update some config and instructions.

Author: rkistner

CONTRIBUTING.md

@@ -1,14 +1,15 @@
 # Contributing
 
-General guidelines for contributing to node-sqlite3
+General guidelines for contributing to node-sqlcipher.
 
-## Install Help
+# Testing
 
-If you've landed here due to a failed install of `node-sqlite3` then feel free to create a [new issue](https://github.com/mapbox/node-sqlite3/issues/new) to ask for help. The most likely problem is that we do not yet provide pre-built binaries for your particular platform and so the `node-sqlite3` install attempted a source compile but failed because you are missing the [dependencies for node-gyp](https://github.com/TooTallNate/node-gyp#installation). But please provide as much detail on your problem as possible and we'll try to help. Please include:
- - terminal logs of failed install (preferably from running `npm install sqlite3 --loglevel=info`)
- - `node-sqlite3` version you tried to install
- - node version you are running
- - operating system and architecture you are running, e.g. `Windows 7 64 bit`.
+[mocha](https://github.com/visionmedia/mocha) is required to run unit tests.
+
+In sqlite3's directory (where its `package.json` resides) run the following:
+
+    npm install --build-from-source
+    npm test
 
 ## Developing / Pre-release
 
@@ -36,13 +37,7 @@ git commit --allow-empty -m "[publish binary]"
 
 **3)** Ensure binaries built
 
-Check the travis and appveyor pages to ensure they are all green as an indication that the `[publish binary]` command worked.
-
-If you need to republish binaries you can do this with the command below, however this should not be a common thing for you to do!
-
-```sh
-git commit --allow-empty -m "[republish binary]"
-```
+Check the CircleCI pages to ensure they are all green as an indication that the `[publish binary]` command worked.
 
 Note: NEVER republish binaries for an existing released version.
 

README.md

@@ -53,21 +53,10 @@ A copy of the source for SQLCipher 4.4.2 is bundled, which is based on SQLite 3.
 
 ## Building from source.
 
-This is done automatically by node-pre-gyp when installing on a platform without pre-built binaries. This should generally
-not be required with later versions, since two pre-built versions (N-API 3 and N-API 6) cover all electron and node versions.
+Building from source when installing the package is only supported up to version 5.2.0.
 
-However, this does require some additional setup, and is likely to run against obscure errors when installing.
-
-Requirements:
-
-### Mac
-
- * `brew install openssl@1.1`
-
-### Windows
-
- * Visual Studio 2015
- * Python 2.7
+The two pre-built versions (N-API 3 and N-API 6) cover all electron and node versions, so building from source should
+not be required.
 
 ## Usage with electron-forge / electron-rebuild
 
@@ -97,7 +86,7 @@ SQLCipher depends on OpenSSL.
 
 For Windows, we bundle OpenSSL 1.1.1i. Binaries are generated using [vckpg](https://github.com/microsoft/vcpkg) (e.g., `.\vcpkg\vcpkg install openssl:x64-windows-static`).
 
-On Mac we build against OpenSSL installed via brew, but statically link it so that end-users do not need to install it.
+On Mac we bundle OpenSSL 1.1.1l.
 
 On Linux we dynamically link against the system OpenSSL.
 
@@ -107,24 +96,6 @@ See the [API documentation](https://github.com/mapbox/node-sqlite3/wiki) in the
 
 Documentation for the SQLCipher extension is available [here](https://www.zetetic.net/sqlcipher/sqlcipher-api/).
 
-# Testing
-
-[mocha](https://github.com/visionmedia/mocha) is required to run unit tests.
-
-In sqlite3's directory (where its `package.json` resides) run the following:
-
-    npm install --build-from-source
-    npm test
-
-# Publishing
-
-To publish a new version, run:
-
-    npm version minor -m "%s [publish binary]"
-    npm publish
-
-Publishing of the prebuilt binaries is performed on CircleCI.
-
 # Acknowledgments
 
 Most of the work in this library is from the [node-sqlite3](https://github.com/mapbox/node-sqlite3) library by [MapBox](https://mapbox.com/).

SQLCipher.md

@@ -22,16 +22,16 @@ The above produces 4 files of interest:
 ```
 sqlite3.c
 sqlite3.h
-shell.c # optional
-sqlite3ext.h # optional
-VERSION # optional
+shell.c
+sqlite3ext.h
+VERSION # rename to VERSION.txt
 ```
 
-The files are copied to: `sqlcipher-amalgamation-<version>`.
+Copy these files to: `deps/sqlcipher-amalgamation`.
 
 ## Step 2: Get OpenSSL libraries
 
-NodeJS typically includes OpenSSL. However, for Electron on Windows, we need to bundle a copy.
+NodeJS typically includes OpenSSL. However, to support Electron, we statically link against libcrypto from OpenSSL.
 
 Run the following commands to generate the latest OpenSSL libs for Windows:
 
@@ -40,25 +40,15 @@ cd deps
 .\openssl-windows.bat
 ```
 
-... this will output the libs in `deps/openssl-windows` (OpenSSL-WinXX), including the header files in `deps/openssl-windows/openssl-include`. Every arch-specific folder includes these binaries:
+... this will output the libs in `deps/` (OpenSSL-WinXX), including the header files in `deps/openssl-include`. Every arch-specific folder includes these binaries:
 
 ```
 libcrypto.lib
 libssl.lib
 ossl_static.pdb
 ```
 
-Copy all folders under `deps/openssl-windows` to `sqlcipher-amalgamation-<version>`.
-
-## Step 3: Build the archive
-
-Archive the folder as `deps/sqlcipher-amalgamation-<version>.tar.gz`, and update the version number in `common-sqlite.gypi` (must be the same).
-
-```
-tar czf sqlcipher-amalgamation-$VERSION.tar.gz sqlcipher-amalgamation-$VERSION
-```
-
-## Step 4: Test the build
+## Step 3: Test the build
 
 Run:
 
@@ -78,7 +68,7 @@ npm run test
 The OpenSSL files are specifically required for Electron, which doesn't bundle OpenSSL like NodeJS does. The header and .lib files are required at compile-time. We bundle a statically-linked version of OpenSSL with the library, so the user does not need to manually install OpenSSL.
 
 `deps/sqlite3.gyp` has been modified from the original node-sqlite3 one to:
- * Use the bundled OpenSSL on Windows.
+ * Use the bundled OpenSSL on Windows and MacOS.
  * Add additional define statements required by SQLCipher.
 
 

deps/common-sqlite.gypi

@@ -1,6 +1,5 @@
 {
   'variables': {
-      'sqlite_version%':'3033000',
       "toolset%":''
   },
   'target_defaults': {

deps/openssl-windows.bat

@@ -8,9 +8,12 @@ if %errorlevel% neq 0 exit /b %errorlevel%
 .\vcpkg\vcpkg install openssl:arm64-windows-static
 if %errorlevel% neq 0 exit /b %errorlevel%
 
-if not exist .\openssl-windows mkdir .\openssl-windows .\openssl-windows\OpenSSL-Win64 .\openssl-windows\OpenSSL-Win32 .\openssl-windows\OpenSSL-Win64-ARM .\openssl-windows\openssl-include\openssl
+if not exist .\OpenSSL-Win32 mkdir .\OpenSSL-Win32
+if not exist .\OpenSSL-Win64 mkdir .\OpenSSL-Win64
+if not exist .\OpenSSL-Win64-ARM mkdir .\OpenSSL-Win64-ARM
+if not exist .\openssl-include mkdir .\openssl-include
 
-copy .\vcpkg\installed\x64-windows-static\lib\*.* .\openssl-windows\OpenSSL-Win64
-copy .\vcpkg\installed\x64-windows-static\include\openssl\*.* .\openssl-windows\openssl-include\openssl
-copy .\vcpkg\installed\x86-windows-static\lib\*.* .\openssl-windows\OpenSSL-Win32
-copy .\vcpkg\installed\arm64-windows-static\lib\*.* .\openssl-windows\OpenSSL-Win64-ARM
+copy .\vcpkg\installed\x64-windows-static\lib\*.* .\OpenSSL-Win64
+copy .\vcpkg\installed\x64-windows-static\include\openssl\*.* .\openssl-include\openssl
+copy .\vcpkg\installed\x86-windows-static\lib\*.* .\OpenSSL-Win32
+copy .\vcpkg\installed\arm64-windows-static\lib\*.* .\OpenSSL-Win64-ARM

package.json

@@ -72,6 +72,7 @@
     "lib/**/*.js",
     "sqlite3.js",
     "src",
+    "deps",
     "*.gyp"
   ]
 }