Working on docs

Author: Rexios80

README.md

@@ -1,39 +1,91 @@
-<!--
-This README describes the package. If you publish this package to pub.dev,
-this README's contents appear on the landing page for your package.
+# Firebase UI OAuth OIDC
 
-For information about how to write a good package README, see the guide for
-[writing package pages](https://dart.dev/guides/libraries/writing-package-pages).
+[![pub package](https://img.shields.io/pub/v/firebase_ui_oauth_oidc.svg)](https://pub.dev/packages/firebase_ui_oauth_oidc)
 
-For general information about developing packages, see the Dart guide for
-[creating packages](https://dart.dev/guides/libraries/create-library-packages)
-and the Flutter guide for
-[developing packages and plugins](https://flutter.dev/developing-packages).
--->
+OIDC Sign In for [Firebase UI Auth](https://pub.dev/packages/firebase_ui_auth)
 
-TODO: Put a short description of the package here that helps potential users
-know whether this package might be useful for them.
+## Installation
 
-## Features
+Add dependency
 
-TODO: List what your package can do. Maybe include images, gifs, or videos.
+```sh
+flutter pub add firebase_ui_auth
+flutter pub add firebase_ui_oauth_oidc
 
-## Getting started
+flutter pub global activate flutterfire_cli
+flutterfire configure
+```
 
-TODO: List prerequisites and provide or point to information on how to
-start using the package.
+Enable OIDC provider on [firebase console](https://console.firebase.google.com/).
 
 ## Usage
 
-TODO: Include short and useful examples for package users. Add longer examples
-to `/example` folder.
+```dart
+import 'package:firebase_core/firebase_core.dart';
+import 'package:firebase_ui_auth/firebase_ui_auth.dart';
+import 'package:firebase_ui_oauth_apple/firebase_ui_oauth_oidc.dart';
+
+void main() {
+    WidgetsFlutterBinding.ensureInitialized();
+    await Firebase.initializeApp(options: DefaultFirebaseOptions.currentPlatform);
+
+    FirebaseUIAuth.configureProviders([
+        AppleProvider(),
+    ]);
+
+    runApp(MyApp());
+}
+
+class MyApp extends StatelessWidget {
+  const MyApp({Key? key}) : super(key: key);
+
+  @override
+  Widget build(BuildContext context) {
+    return MaterialApp(
+      home: SignInScreen(
+        actions: [
+          AuthStateChangeAction<SignedIn>((context, state) {
+            // redirect to other screen
+          })
+        ],
+      ),
+    );
+  }
+}
+```
+
+Alternatively you could use the `OAuthProviderButton`
 
 ```dart
-const like = 'sample';
+class MyScreen extends StatelessWidget {
+  @override
+  Widget build(BuildContext context) {
+    return AuthStateListener<OAuthController>(
+      listener: (oldState, newState, controller) {
+        if (newState is SignedIn) {
+          // navigate to other screen.
+        }
+      },
+      child: OAuthProviderButton(
+        provider: AppleProvider(),
+      ),
+    );
+  }
+}
 ```
 
-## Additional information
+Also there is a standalone version of the `AppleSignInButton`
 
-TODO: Tell users more about the package: where to find more information, how to
-contribute to the package, how to file issues, what response they can expect
-from the package authors, and more.
+```dart
+class MyScreen extends StatelessWidget {
+  @override
+  Widget build(BuildContext context) {
+    return AppleSignInButton(
+      loadingIndicator: CircularProgressIndicator(),
+      onSignedIn: (UserCredential credential) {
+        // perform navigation.
+      }
+    );
+  }
+}
+```

pubspec.lock

@@ -107,12 +107,12 @@ packages:
     source: hosted
     version: "5.1.1"
   firebase_core:
-    dependency: transitive
+    dependency: "direct dev"
     description:
       name: firebase_core
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "2.1.1"
+    version: "2.3.0"
   firebase_core_platform_interface:
     dependency: transitive
     description:
@@ -158,9 +158,9 @@ packages:
   firebase_ui_oauth:
     dependency: "direct main"
     description:
-      path: "../flutterfire/packages/firebase_ui_oauth"
-      relative: true
-    source: path
+      name: firebase_ui_oauth
+      url: "https://pub.dartlang.org"
+    source: hosted
     version: "1.0.4"
   flutter:
     dependency: "direct main"

pubspec.yaml

@@ -19,4 +19,4 @@ dev_dependencies:
     sdk: flutter
 
   rexios_lints: ^4.0.0
-
+  firebase_core: ^2.3.0

readme/firebase_options.dart

@@ -0,0 +1,10 @@
+import 'package:firebase_core/firebase_core.dart';
+
+class DefaultFirebaseOptions {
+  static FirebaseOptions get currentPlatform => const FirebaseOptions(
+        apiKey: '',
+        appId: '',
+        messagingSenderId: '',
+        projectId: '',
+      );
+}

readme/usage.dart

@@ -0,0 +1,34 @@
+import 'package:firebase_core/firebase_core.dart';
+import 'package:firebase_ui_auth/firebase_ui_auth.dart';
+import 'package:firebase_ui_oauth_oidc/firebase_ui_oauth_oidc.dart';
+import 'package:flutter/material.dart';
+
+import 'firebase_options.dart';
+
+void main() async {
+    WidgetsFlutterBinding.ensureInitialized();
+    await Firebase.initializeApp(options: DefaultFirebaseOptions.currentPlatform);
+
+    FirebaseUIAuth.configureProviders([
+        OidcProvider(providerId: 'oidc.example', style: ),
+    ]);
+
+    runApp(const MyApp());
+}
+
+class MyApp extends StatelessWidget {
+  const MyApp({Key? key}) : super(key: key);
+
+  @override
+  Widget build(BuildContext context) {
+    return MaterialApp(
+      home: SignInScreen(
+        actions: [
+          AuthStateChangeAction<SignedIn>((context, state) {
+            // redirect to other screen
+          })
+        ],
+      ),
+    );
+  }
+}