Incorporate documentation and PKG-Config improvements from PR #9

Author: vkuttyp

README.md

@@ -33,47 +33,59 @@ This is a Swift rewrite and modernisation of [martinrybak/SQLClient](https://git
 | tvOS | 16.0 |
 | Xcode | 15.0 |
 | Swift | 5.9 |
+| PKG-Config | 0.29+ (macOS) |
 | FreeTDS | 1.0 (1.5 recommended) |
 
 ---
 
 ## Installation
 
-### Swift Package Manager
+> **Note for macOS:** If you encounter compilation errors like `'sybdb.h' file not found`, you need to configure `pkg-config` to correctly link your FreeTDS installation. See [PKG-Config Configuration](#pkg-config-configuration) below.
 
-Add the dependency to your `Package.swift`:
+### Swift Package Manager
+...
+**macOS (Homebrew):**
+```bash
+brew install freetds
+```
 
-```swift
-dependencies: [
-    .package(url: "https://github.com/vkuttyp/SQLClient-Swift.git", from: "1.0.0")
-],
-targets: [
-    .target(
-        name: "MyApp",
-        dependencies: [
-            .product(name: "SQLClientSwift", package: "SQLClient-Swift")
-        ]
-    )
-]
+**Linux (apt):**
+```bash
+sudo apt install freetds-dev
 ```
 
-Or in Xcode: **File → Add Package Dependencies…** and enter the repository URL.
+**iOS / custom build:** Use a pre-compiled `libsybdb.a` (e.g. from [FreeTDS-iOS](https://github.com/patchhf/FreeTDS-iOS)) and link it manually in your Xcode target under **Build Phases → Link Binary With Libraries**, along with `libiconv.tbd`.
+
+### PKG-Config Configuration (macOS)
 
-### Install FreeTDS
+For systems that do not natively include `pkg-config` or where Homebrew does not provide a `.pc` file for FreeTDS (common on macOS), extra steps are required.
 
-SQLClient-Swift wraps FreeTDS — you need the native library present at build time.
+**1. Install pkg-config**
 
-**macOS (Homebrew):**
 ```bash
-brew install freetds
+brew install pkg-config
 ```
 
-**Linux (apt):**
+**2. Configure freetds.pc**
+
+A `freetds.pc` file is provided in the `ci/` folder of this repository. You need to make this file available to `pkg-config`.
+
+**Option A: Export PKG_CONFIG_PATH (Recommended)**
+Point `pkg-config` to the `ci/` folder in your local copy of this repo:
 ```bash
-sudo apt install freetds-dev
+export PKG_CONFIG_PATH="$PKG_CONFIG_PATH:/path/to/SQLClient-Swift/ci"
 ```
 
-**iOS / custom build:** Use a pre-compiled `libsybdb.a` (e.g. from [FreeTDS-iOS](https://github.com/patchhf/FreeTDS-iOS)) and link it manually in your Xcode target under **Build Phases → Link Binary With Libraries**, along with `libiconv.tbd`.
+**Option B: Copy to system path**
+Copy the file to your system's pkg-config directory:
+```bash
+cp ci/freetds.pc /usr/local/lib/pkgconfig/
+```
+
+**Note on Intel vs Apple Silicon:**
+The provided `ci/freetds.pc` is configured for Apple Silicon (`/opt/homebrew`). If you are on an **Intel Mac**, edit the `prefix` line in the file:
+- **Apple Silicon:** `prefix=/opt/homebrew/opt/freetds`
+- **Intel:** `prefix=/usr/local/opt/freetds`
 
 ---
 

ci/freetds.pc

@@ -1,7 +1,12 @@
-# FreeTDS pkg-config file for macOS (Apple Silicon)
-# Committed to repo because Homebrew's freetds does not ship a .pc file on macOS.
+# FreeTDS pkg-config file for macOS
+# Homebrew's freetds does not ship a .pc file on macOS.
 # Linux users: this file is ignored; FreeTDS is found via system pkg-config.
+
+# --- PREFIX CONFIGURATION ---
+# Apple Silicon (M1/M2/M3): /opt/homebrew/opt/freetds
+# Intel Mac: /usr/local/opt/freetds
 prefix=/opt/homebrew/opt/freetds
+
 exec_prefix=${prefix}
 libdir=${exec_prefix}/lib
 includedir=${prefix}/include