Skip to content

Commit 096f79a

Browse files
Merge pull request #82 from passageidentity/PSG-4891-repo-templates
Psg 4891 Use repo templates in passage-flutter
2 parents 4af400f + f088427 commit 096f79a

9 files changed

+69
-301
lines changed

.github/PULL_REQUEST_TEMPLATE.md

-41
This file was deleted.

CODE_OF_CONDUCT.md

-133
This file was deleted.

CONTRIBUTING.md

-49
This file was deleted.

ISSUE_TEMPLATE.md

-36
This file was deleted.

LICENSE

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
MIT License
22

3-
Copyright (c) 2023 Passage Identity, Inc
3+
Copyright (c) 2024 Passage by 1Password
4+
45
Permission is hereby granted, free of charge, to any person obtaining a copy
56
of this software and associated documentation files (the "Software"), to deal
67
in the Software without restriction, including without limitation the rights
@@ -17,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
1718
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1819
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
1920
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20-
SOFTWARE.
21+
SOFTWARE.

README.md

+59-20
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,77 @@
1-
<img src="https://storage.googleapis.com/passage-docs/Lockup%20Vertical%20color.png" alt="Passage logo" style="width:250px;"/>
1+
![passage-flutter](https://storage.googleapis.com/passage-docs/github-md-assets/passage-flutter.png)
22

3-
[![Pub](https://img.shields.io/pub/v/passage_flutter.svg)](https://pub.dartlang.org/packages/passage_flutter)
3+
[![Pub](https://img.shields.io/pub/v/passage_flutter.svg)](https://pub.dartlang.org/packages/passage_flutter) ![GitHub License](https://img.shields.io/github/license/passageidentity/passage-flutter) [![Flutter](https://img.shields.io/badge/Flutter-02569B?logo=flutter&logoColor=fff)](#) [![Dart](https://img.shields.io/badge/Dart-%230175C2.svg?logo=dart&logoColor=white)](#) ![Static Badge](https://img.shields.io/badge/Built_by_1Password-grey?logo=1password)
44

5-
### Native passkey authentication for your Flutter app
6-
## Welcome!
7-
Integrating passkey technology can be really hard. That's why we built the Passage Flutter SDK - to make passkey authentication easy for you and your users - across native iOS, native Android, and web.
5+
## About
86

9-
<img width="1069" alt="Passage Flutter" src="https://storage.googleapis.com/passage-docs/passage-flutter.png">
7+
[Passage by 1Password](https://1password.com/product/passage) unlocks the passwordless future with a simpler, more secure passkey authentication experience. Passage handles the complexities of the [WebAuthn API](https://blog.1password.com/what-is-webauthn/), and allows you to implement passkeys with ease.
108

11-
<br>
9+
Use [Passkey Flex](https://docs.passage.id/flex) to add passkeys to an existing authentication experience.
1210

13-
## Installation
11+
Use [Passkey Complete](https://docs.passage.id/complete) as a standalone passwordless auth solution.
1412

15-
```sh
13+
Use [Passkey Ready](https://docs.passage.id/passkey-ready) to determine if your users are ready for passkeys.
14+
15+
### In passage-flutter
16+
17+
Use passage-flutter to implement Passkey Complete in your Flutter application to authenticate requests and manage users.
18+
19+
| Product | Compatible |
20+
| ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21+
| ![Passkey Flex](https://storage.googleapis.com/passage-docs/github-md-assets/passage-passkey-flex-icon.png) Passkey **Flex** | ✖️ For Passkey Flex, check out the [Passkey Flex for Android](https://github.com/passageidentity/passage-android/tree/main/passageflex) and [Passkey Flex for iOS](https://github.com/passageidentity/passage-flex-ios) |
22+
| ![Passkey Complete](https://storage.googleapis.com/passage-docs/github-md-assets/passage-passkey-complete-icon.png) Passkey **Complete** ||
23+
| ![Passkey Ready](https://storage.googleapis.com/passage-docs/github-md-assets/passage-passkey-ready-icon.png) Passkey **Ready** | ✖️ For Passkey Ready, check out [Authentikit for Android](https://github.com/passageidentity/passage-android/tree/main/authentikit) and [Authentikit for iOS](https://github.com/passageidentity/passage-authentikit-ios) |
24+
25+
<br />
26+
27+
## Getting Started
28+
29+
### Check Prerequisites
30+
31+
<p>
32+
You'll need a free Passage account and a Passkey Complete app set up in <a href="https://console.passage.id/">Passage Console</a> to get started. <br />
33+
<sub><a href="https://docs.passage.id/home#passage-console">Learn more about Passage Console →</a></sub>
34+
</p>
35+
36+
### Install
37+
38+
```shell
1639
flutter pub add passage_flutter
1740
```
18-
<br>
1941

20-
## Example Usage
42+
### Import
2143

2244
```dart
2345
import 'package:passage_flutter/passage_flutter.dart';
46+
```
47+
48+
### Initialize
2449

50+
```dart
2551
final passage = PassageFlutter('YOUR_PASSAGE_APP_ID');
52+
```
2653

27-
// Register a new user with a passkey
28-
await passage.passkey.register('[email protected]');
54+
### Go Passwordless
2955

30-
// Get authenticated user info
31-
final user = await passage.currentUser.userInfo();
32-
```
56+
Find all core functions, user management details, and more implementation guidance on our [Passkey Complete Flutter Documentation](https://docs.passage.id/complete/flutter/add-passage) page.
57+
58+
## Support & Feedback
59+
60+
We are here to help! Find additional docs, the best ways to get in touch with our team, and more within our [support resources](https://github.com/passageidentity/.github/blob/main/SUPPORT.md).
61+
62+
<br />
63+
64+
---
3365

34-
To see a full example, check out our [Flutter Example App](https://github.com/passageidentity/example-flutter).
35-
<br>
66+
<p align="center">
67+
<picture>
68+
<source media="(prefers-color-scheme: dark)" srcset="https://storage.googleapis.com/passage-docs/github-md-assets/passage-by-1password-dark.png">
69+
<source media="(prefers-color-scheme: light)" srcset="https://storage.googleapis.com/passage-docs/github-md-assets/passage-by-1password-light.png">
70+
<img alt="Passage by 1Password Logo" src="https://storage.googleapis.com/passage-docs/github-md-assets/passage-by-1password-light.png">
71+
</picture>
72+
</p>
3673

37-
## Documentation
38-
To get started using Passage in your Flutter app, please visit our [Passage Docs](https://docs.passage.id/mobile/cross-platform/flutter).
74+
<p align="center">
75+
<sub>Passage is a product by <a href="https://1password.com/product/passage">1Password</a>, the global leader in access management solutions with nearly 150k business customers.</sub><br />
76+
<sub>This project is licensed under the MIT license. See the <a href="LICENSE.md">LICENSE</a> file for more info.</sub>
77+
</p>

SECURITY.md

-13
This file was deleted.

0 commit comments

Comments
 (0)