-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3 from passageidentity/PSG-3807-add-readme
Create README.md
- Loading branch information
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/). |