Skip to content

Commit c5a4837

Browse files
committed
Add DocC documentation catalog and opt-in to SPI hosting
1 parent ffb6938 commit c5a4837

File tree

3 files changed

+26
-0
lines changed

3 files changed

+26
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,4 @@ DerivedData/
1515
.idea/
1616
*.swp
1717
*~
18+
dd/

.spi.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,4 @@ builder:
2626
linux_packages:
2727
- freetds-dev
2828
- pkg-config
29+
documentation_targets: [SQLClientSwift]
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# ``SQLClientSwift``
2+
3+
A modern, native Microsoft SQL Server client for iOS, macOS, and Linux — written in Swift.
4+
5+
## Overview
6+
7+
SQLClient-Swift provides a clean, asynchronous API for interacting with SQL Server databases. It is built on top of the open-source FreeTDS library, offering a high-performance and reliable connection layer.
8+
9+
### Key Features
10+
11+
- **Native Support**: Works on all Apple platforms and Linux.
12+
- **Modern API**: Leverages Swift's `async/await` for asynchronous operations.
13+
- **Type Safety**: Automatic mapping of database rows to Swift `Decodable` types.
14+
- **Thread Safety**: Uses Swift actors to ensure safe concurrent access to database connections.
15+
- **Full Encryption Support**: Supports TLS/SSL for Azure SQL and modern SQL Server instances.
16+
17+
## Topics
18+
19+
### Essentials
20+
21+
- ``SQLClient``
22+
- ``SQLClientConnectionOptions``
23+
- ``SQLClientResult``
24+
- ``SQLRow``

0 commit comments

Comments
 (0)