Skip to content

Add installation instruction for Swift packages. Update ephemeraHQ/PasskeyAuth.git -> xmtplabs/PasskeyAuth.git #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Sajjon wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add installation instruction for Swift packages. Update ephemeraHQ/PasskeyAuth.git -> xmtplabs/PasskeyAuth.git #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 29 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down