Skip to content

Commit 4521c35

Browse files
committed
README cleanup
- Stop using numeric link references. - Document discrepancy between SQLCipher and FTS4 Signed-off-by: Stephen Celis <stephen@stephencelis.com>
1 parent e0e94a3 commit 4521c35

File tree

1 file changed

+33
-25
lines changed

1 file changed

+33
-25
lines changed

README.md

Lines changed: 33 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# SQLite.swift
22

3-
A type-safe, [Swift][1.1]-language layer over [SQLite3][1.2].
3+
A type-safe, [Swift][]-language layer over [SQLite3][].
44

5-
[SQLite.swift][1.3] provides compile-time confidence in SQL statement
5+
[SQLite.swift][] provides compile-time confidence in SQL statement
66
syntax _and_ intent.
77

8-
[1.1]: https://developer.apple.com/swift/
9-
[1.2]: http://www.sqlite.org
10-
[1.3]: https://github.com/stephencelis/SQLite.swift
8+
[Swift]: https://developer.apple.com/swift/
9+
[SQLite3]: http://www.sqlite.org
10+
[SQLite.swift]: https://github.com/stephencelis/SQLite.swift
1111

1212

1313
## Features
@@ -104,22 +104,22 @@ interactively, from the Xcode project’s playground.
104104

105105
## Installation
106106

107-
> _Note:_ SQLite.swift requires Swift 1.1 (and [Xcode
108-
> 6.1](https://developer.apple.com/xcode/downloads/)) or greater.
107+
> _Note:_ SQLite.swift requires Swift 1.1 (and [Xcode][] 6.1) or
108+
> greater.
109109
>
110110
> For the Swift 1.2 beta (included in Xcode 6.3), use the
111111
> [`swift-1-2`](https://github.com/stephencelis/SQLite.swift/tree/swift-1-2)
112112
> branch.
113113
>
114114
> The following instructions apply to targets that support embedded
115115
> Swift frameworks. To use SQLite.swift in iOS 7 or an OS X command line
116-
> tool, please read the [Frameworkless Targets][4.0] section of the
116+
> tool, please read the [Frameworkless Targets][] section of the
117117
> documentation.
118118
119119
To install SQLite.swift:
120120

121121
1. Drag the **SQLite.xcodeproj** file into your own project.
122-
([Submodule][4.2], clone, or [download][4.3] the project first.)
122+
([Submodule][], clone, or [download][] the project first.)
123123

124124
![](Documentation/Resources/installation@2x.png)
125125

@@ -132,10 +132,10 @@ To install SQLite.swift:
132132
4. Add **SQLite.framework** to a **Copy Files** build phase with a
133133
**Frameworks** destination. (Add a new build phase if need be.)
134134

135-
[4.0]: Documentation/Index.md#frameworkless-targets
136-
[4.1]: https://developer.apple.com/xcode/downloads/
137-
[4.2]: http://git-scm.com/book/en/Git-Tools-Submodules
138-
[4.3]: https://github.com/stephencelis/SQLite.swift/archive/master.zip
135+
[Frameworkless Targets]: Documentation/Index.md#frameworkless-targets
136+
[Xcode]: https://developer.apple.com/xcode/downloads/
137+
[Submodule]: http://git-scm.com/book/en/Git-Tools-Submodules
138+
[download]: https://github.com/stephencelis/SQLite.swift/archive/master.zip
139139

140140

141141
### SQLCipher
@@ -150,19 +150,29 @@ To install SQLite.swift with [SQLCipher][] support:
150150
2. Follow [the instructions above](#installation) with the
151151
**SQLiteCipher** target, instead.
152152

153+
> _Note:_ By default, SQLCipher compiles [without support for full-text
154+
> search][]. If you intend to use [FTS4][], make sure you add the
155+
> following to **Other C Flags** in the **Build Settings** of the
156+
> **sqlcipher** target (in the **sqlcipher.xcodeproj** project):
157+
>
158+
> - `-DSQLITE_ENABLE_FTS4`
159+
> - `-DSQLITE_ENABLE_FTS3_PARENTHESIS`
160+
153161
[SQLCipher]: http://sqlcipher.net
162+
[without support for full-text search]: https://github.com/sqlcipher/sqlcipher/issues/102
163+
[FTS4]: http://www.sqlite.org/fts3.html
154164

155165

156166
## Communication
157167

158168
- Need **help** or have a **general question**? [Ask on Stack
159-
Overflow][5.1] (tag `sqlite.swift`).
160-
- Found a **bug** or have a **feature request**? [Open an issue][5.2].
161-
- Want to **contribute**? [Submit a pull request][5.3].
169+
Overflow][] (tag `sqlite.swift`).
170+
- Found a **bug** or have a **feature request**? [Open an issue][].
171+
- Want to **contribute**? [Submit a pull request][].
162172

163-
[5.1]: http://stackoverflow.com/questions/tagged/sqlite.swift
164-
[5.2]: https://github.com/stephencelis/SQLite.swift/issues/new
165-
[5.3]: https://github.com/stephencelis/SQLite.swift/fork
173+
[Ask on Stack Overflow]: http://stackoverflow.com/questions/tagged/sqlite.swift
174+
[Open an issue]: https://github.com/stephencelis/SQLite.swift/issues/new
175+
[Submit a pull request]: https://github.com/stephencelis/SQLite.swift/fork
166176

167177

168178
## Author
@@ -173,15 +183,13 @@ To install SQLite.swift with [SQLCipher][] support:
173183

174184
## License
175185

176-
SQLite.swift is available under the MIT license. See [the LICENSE file][7.1]
177-
for more information.
178-
179-
[7.1]: ./LICENSE.txt
186+
SQLite.swift is available under the MIT license. See [the LICENSE
187+
file](./LICENSE.txt) for more information.
180188

181189

182190
## Alternatives
183191

184-
Looking for something else? Try another Swift wrapper (or [FMDB][8.1]):
192+
Looking for something else? Try another Swift wrapper (or [FMDB][]):
185193

186194
- [Camembert](https://github.com/remirobert/Camembert)
187195
- [EonilSQLite3](https://github.com/Eonil/SQLite3)
@@ -190,4 +198,4 @@ Looking for something else? Try another Swift wrapper (or [FMDB][8.1]):
190198
- [SwiftData](https://github.com/ryanfowler/SwiftData)
191199
- [SwiftSQLite](https://github.com/chrismsimpson/SwiftSQLite)
192200

193-
[8.1]: https://github.com/ccgus/fmdb
201+
[FMDB]: https://github.com/ccgus/fmdb

0 commit comments

Comments
 (0)