Skip to content

Commit ce735cf

Browse files
committed
Document SQLCipher installation
Signed-off-by: Stephen Celis <stephen@stephencelis.com>
1 parent 11822e7 commit ce735cf

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

Documentation/Index.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# SQLite.swift Documentation
22

33
- [Installation](#installation)
4+
- [SQLCipher](#sqlcipher)
45
- [Getting Started](#getting-started)
56
- [Connecting to a Database](#connecting-to-a-database)
67
- [Read-Write Databases](#read-write-databases)
@@ -76,6 +77,17 @@ To install SQLite.swift as an Xcode sub-project:
7677
You should now be able to `import SQLite` from any of your target’s source files and begin using SQLite.swift.
7778

7879

80+
### SQLCipher
81+
82+
To install SQLite.swift with [SQLCipher][] support:
83+
84+
1. Make sure the **sqlcipher** working copy is checked out into Xcode. If **sqlcipher.xcodeproj** (in the **Vendor** group) is red, go to the **Source Control** menu and select **Check Out sqlcipher…** from the **sqlcipher** menu item.
85+
86+
2. Follow [the instructions above](#installation) with the **SQLiteCipher** target, instead.
87+
88+
[SQLCipher]: http://sqlcipher.net
89+
90+
7991
## Getting Started
8092

8193
To use SQLite.swift classes or structures in your target’s source file, first import the `SQLite` module.

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ syntax _and_ intent.
1919
- A lightweight, uncomplicated query and parameter binding interface
2020
- Transactions with implicit commit/rollback
2121
- Developer-friendly error handling and debugging
22+
- [SQLCipher](#sqlcipher) support
2223
- [Well-documented][See Documentation]
2324
- Extensively tested
2425

@@ -127,6 +128,21 @@ To install SQLite.swift:
127128
[4.3]: https://github.com/stephencelis/SQLite.swift/archive/master.zip
128129

129130

131+
### SQLCipher
132+
133+
To install SQLite.swift with [SQLCipher][] support:
134+
135+
1. Make sure the **sqlcipher** working copy is checked out into Xcode.
136+
If **sqlcipher.xcodeproj** (in the **Vendor** group) is red, go to
137+
the **Source Control** menu and select **Check Out sqlcipher…** from
138+
the **sqlcipher** menu item.
139+
140+
2. Follow [the instructions above](#installation) with the
141+
**SQLiteCipher** target, instead.
142+
143+
[SQLCipher]: http://sqlcipher.net
144+
145+
130146
## Communication
131147

132148
- Found a **bug** or have a **feature request**? [Open an issue][5.1].

0 commit comments

Comments
 (0)