summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst26
1 files changed, 17 insertions, 9 deletions
diff --git a/README.rst b/README.rst
index 4b140cd..0a1f1dc 100644
--- a/README.rst
+++ b/README.rst
@@ -7,7 +7,7 @@ linux environments). It links against against libsqlcipher.
Original code (c) 2004-2007 Gerhard Häring
-Packaging for SQLCipher (c) 2013-2014 Kali Kaneko
+Packaging for SQLCipher (c) 2013-2016 Kali Kaneko
Usage
@@ -31,17 +31,25 @@ You can quickly verify that your database file in indeed encrypted::
77 bf e3 1d 65 b5 ea f7 d2 fc 98 31 23 66 a0 1e |w...e......1#f..|
a4 4f fa 66 49 36 84 a1 3e 0c 21 98 84 07 eb 07 |.O.fI6..>.!.....|
-Build against libsqlcipher
---------------------------
-For convenience, this package uses a sqlcipher amalgamation during the regular
+Build against bundled libsqlcipher
+-----------------------------------
+The default behaviour is to link against libsqlcipher in the system.
+
+For convenience, this package includes a sqlcipher amalgamation during the regular
install. See https://www.sqlite.org/amalgamation.html
-For production use, you should build against ``libsqlcipher`` installed in your
-system, you can do it like this::
+If you don't have sqlcipher installed in the system, you can use the bundled
+pysqlcipher::
+
+ python setup.py install --bundled
+
+You can also pass a different amalgamation path, that you have previously
+downloaded::
- python setup.py build_sqlcipher
+ python setup.py install --bundled --amalgamation=/tmp/path/to/amalgamation
-And then::
+If you are installing from pip but for some reason you prefer to use the bundled
+sqlcipher, you should pass the option along::
- python setup.py install
+ pip install pysqlcipher --install-option="--bundled"