Merge pull request #82 from passageidentity/PSG-4891-repo-templates

Psg 4891 Use repo templates in passage-flutter

LICENSE

@@ -1,6 +1,7 @@
 MIT License
 
-Copyright (c) 2023 Passage Identity, Inc
+Copyright (c) 2024 Passage by 1Password
+
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 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
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

README.md

@@ -1,38 +1,77 @@
-<img src="https://storage.googleapis.com/passage-docs/Lockup%20Vertical%20color.png" alt="Passage logo" style="width:250px;"/>
+![passage-flutter](https://storage.googleapis.com/passage-docs/github-md-assets/passage-flutter.png)
 
-[![Pub](https://img.shields.io/pub/v/passage_flutter.svg)](https://pub.dartlang.org/packages/passage_flutter)
+[![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)
 
-### Native passkey authentication for your Flutter app
-## Welcome!
-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.
+## About
 
-<img width="1069" alt="Passage Flutter" src="https://storage.googleapis.com/passage-docs/passage-flutter.png">
+[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.
 
-<br>
+Use [Passkey Flex](https://docs.passage.id/flex) to add passkeys to an existing authentication experience.
 
-## Installation
+Use [Passkey Complete](https://docs.passage.id/complete) as a standalone passwordless auth solution.
 
-```sh
+Use [Passkey Ready](https://docs.passage.id/passkey-ready) to determine if your users are ready for passkeys.
+
+### In passage-flutter
+
+Use passage-flutter to implement Passkey Complete in your Flutter application to authenticate requests and manage users.
+
+| Product                                                                                                                                  | Compatible                                                                                                                                                                                                                |
+| ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| ![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)   |
+| ![Passkey Complete](https://storage.googleapis.com/passage-docs/github-md-assets/passage-passkey-complete-icon.png) Passkey **Complete** | ✅                                                                                                                                                                                                                        |
+| ![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) |
+
+<br />
+
+## Getting Started
+
+### Check Prerequisites
+
+<p>
+ 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 />
+ <sub><a href="https://docs.passage.id/home#passage-console">Learn more about Passage Console →</a></sub>
+</p>
+
+### Install
+
+```shell
 flutter pub add passage_flutter
 ```
-<br>
 
-## Example Usage
+### Import
 
 ```dart
 import 'package:passage_flutter/passage_flutter.dart';
+```
+
+### Initialize
 
+```dart
 final passage = PassageFlutter('YOUR_PASSAGE_APP_ID');
+```
 
-// Register a new user with a passkey
-await passage.passkey.register('[email protected]');
+### Go Passwordless
 
-// Get authenticated user info
-final user = await passage.currentUser.userInfo();
-```
+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.
+
+## Support & Feedback
+
+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).
+
+<br />
+
+---
 
-To see a full example, check out our [Flutter Example App](https://github.com/passageidentity/example-flutter).
-<br>
+<p align="center">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://storage.googleapis.com/passage-docs/github-md-assets/passage-by-1password-dark.png">
+      <source media="(prefers-color-scheme: light)" srcset="https://storage.googleapis.com/passage-docs/github-md-assets/passage-by-1password-light.png">
+      <img alt="Passage by 1Password Logo" src="https://storage.googleapis.com/passage-docs/github-md-assets/passage-by-1password-light.png">
+    </picture>
+</p>
 
-## Documentation
-To get started using Passage in your Flutter app, please visit our [Passage Docs](https://docs.passage.id/mobile/cross-platform/flutter).
+<p align="center">
+    <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 />
+    <sub>This project is licensed under the MIT license. See the <a href="LICENSE.md">LICENSE</a> file for more info.</sub>
+</p>