-
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.
* docs(PSG-4350): added README.md * fix: fixed bottom logo
- Loading branch information
1 parent
ddcd1c5
commit 4b9b700
Showing
1 changed file
with
61 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,61 @@ | ||
![Passage Swift](https://storage.googleapis.com/passage-docs/passage-github-banner.png) | ||
|
||
# Passage Swift | ||
|
||
![SPM Version](https://img.shields.io/github/v/release/passageidentity/passage-swift?style=flat&label=Swift%20Package) | ||
![Cocoapods Version](https://img.shields.io/github/v/release/passageidentity/passage-swift?style=flat&label=CocoaPods) | ||
|
||
![Language](https://img.shields.io/badge/Swift-informational?style=flat&logo=swift&logoColor=white&color=FA7343) | ||
![Platforms](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fpassage-swift%2Fpassage-swift%2Fbadge%3Ftype%3Dplatforms) | ||
![Company](https://img.shields.io/badge/1Password-informational?style=flat&logo=1password&logoColor=white&color=3B66BC) | ||
![License](https://img.shields.io/github/license/passageidentity/passage-swift.svg?style=flat) | ||
|
||
<br /> | ||
|
||
## ⚙️ Installation | ||
### Swift Package Manager | ||
To install via Swift Package Manager, enter this url Xcode's Swift Package Manager's search bar: | ||
``` | ||
https://github.com/passageidentity/passage-swift | ||
``` | ||
|
||
### CocoaPods | ||
To install via Cocoapods, add this dependency to your Podfile: | ||
``` ruby | ||
pod 'PassageSwift' | ||
``` | ||
|
||
<br /> | ||
|
||
## 👩🏽💻 Example Usage | ||
Below is an example of how easy it is to use Passage Swift to register a new user with a passkey and get their auth token: | ||
|
||
``` swift | ||
import Passage | ||
|
||
let passage = Passage(appId: "YOUR_PASSAGE_APP_ID") | ||
|
||
try await passage.passkey.register(identifier: "[email protected]") | ||
|
||
let authToken = passage.tokenStore.authToken | ||
``` | ||
|
||
<br /> | ||
|
||
## 🚀 Get Started | ||
### Visit our 📚 [Passage Swift Docs](https://docs.passage.id) to get started adding Passage to your Swift app. | ||
<br /> | ||
|
||
--- | ||
<br /> | ||
<p align="center"> | ||
<picture> | ||
<source media="(prefers-color-scheme: light)" srcset="https://storage.googleapis.com/passage-docs/logo-small-light.pngg" width="150"> | ||
<source media="(prefers-color-scheme: dark)" srcset="https://storage.googleapis.com/passage-docs/logo-small-dark.png" width="150"> | ||
<img alt="Passage Logo" src="https://storage.googleapis.com/passage-docs/logo-small-light.png" width="150"> | ||
</picture> | ||
</p> | ||
|
||
<p align="center">Give customers the passwordless future they deserve. To learn more check out <a href="https://passage.1password.com">passage.1password.com</a></p> | ||
|
||
<p align="center">This project is licensed under the MIT license. See the <a href="./LICENSE"> LICENSE</a> file for more info.</p> |