From 44e9c9a3ef746e0ca123e2cb1fe464e0f727feb5 Mon Sep 17 00:00:00 2001 From: Alexander Cyon Date: Fri, 5 Dec 2025 10:55:55 +0100 Subject: [PATCH] Clarify that current installation instruction are for Xcode projects, add installation instruction for Package --- README.md | 34 +++++++++++++++++++++++++++++----- 1 file changed, 29 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2d3ba75..ee76233 100644 --- a/README.md +++ b/README.md @@ -4,21 +4,45 @@ A Swift package that provides a simple way to implement passkey authentication i ## Requirements -- iOS 16.0+ / macOS 13.0+ -- Xcode 14.0+ - Swift 5.9+ +- Xcode 14.0+ +- iOS 16.0+ / macOS 13.0+ ## Installation -### Swift Package Manager +You can add PasskeyAuth as a dependency using [Swift Package Manager (SPM)](https://swift.org/package-manager/) either for your own Package or in your Xcode project. + +### SPM in Package + +Add PasskeyAuth in `dependencies` of your package description: + +```swift +dependencies: [ + .package(url: "https://github.com/xmtplabs/PasskeyAuth.git", branch: "main") +] +``` + +> [!NOTE] +> PasskeyAuth has no release yet, so for now you must use `branch: "main"`, but when XMTP Labs have +> made a release you should specify a version instead. + +then add `PasskeyAuth` as a dependency of your target(s): + +```swift +dependencies: [ + .product(name: "PasskeyAuth", package: "PasskeyAuth") +] +``` + +### SPM in Xcode project -Add PasskeyAuth to your project using Swift Package Manager: +To add PasskeyAuth to your Xcode project: 1. In Xcode, select your project in the Project Navigator 2. Select your target 3. Select the "Package Dependencies" tab 4. Click the "+" button -5. Enter the repository URL: `https://github.com/ephemeraHQ/PasskeyAuth.git` +5. Enter the repository URL: `https://github.com/xmtplabs/PasskeyAuth.git` 6. Click "Add Package" ## Usage