Skip to content
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.

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

Create README.md #3

Merged
merged 1 commit into from
Apr 1, 2024
Merged
Changes from all commits
Commits
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
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<img src="https://storage.googleapis.com/passage-docs/passage-logo-gradient.svg" alt="Passage logo" style="width:250px;"/>

### Native passkey authentication for your iOS app
## Welcome!
Integrating passkey technology can be really hard. That's why we built the PassageFlex iOS SDK - to make passkey authentication easy for you and your users.
<br>

## Usage

### Installation

You can import the PassageFlex via the Swift Package Manager. Simply search SPM for this url:
```
https://github.com/passageidentity/passage-flex-ios
```
Or you can import it using CocoaPods by add this pod to your app's Podfile:
```
pod 'PassageFlex'
```

### Example
And you can use it like this:
```swift
import PassageFlex

let nonce = try await PassageFlex.Passkey.authenticate()
```
<br>

## Documentation
To get started using PassageFlex in your iOS app, please visit our [Passage Docs](https://docs.passage.id/mobile/ios/).