Skip to content

Commit cadaeff

Browse files
docs: update readme and docs
1 parent c231127 commit cadaeff

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<p align="center"><img src="assets/lit.png" height="125" alt="Lit Firebase"></p>
1+
<p align="center"><img src="https://raw.githubusercontent.com/funwithflutter/lit_firebase_auth/assets/lit.png" height="125" alt="Lit Firebase"></p>
22

33
<h1 align="center" style="margin-top: 0px; font-size: 4em;">Lit Firebase Auth</h1>
44

@@ -140,6 +140,7 @@ LitAuth(
140140
```
141141

142142
This will use the default configuration and UI theming. See the section on decoration and theming for customization.
143+
**NOTE**: This widget needs to be below a `Scaffold` widget.
143144

144145
### Handle auth state changes
145146
To determine the current auth state, make use of `LitAuthState`:

lib/src/presentation/lit_auth_ui.dart

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,9 @@ class LitAuthState extends StatelessWidget {
6666
typedef AuthFailureCallback = void Function(AuthFailure failure);
6767

6868
/// The main widget to do any form of Authentication using **LitFirebaseAuth**.
69+
///
70+
/// Must be below a [Scaffold].
71+
///
6972
/// This widget is used to configure the UI, provide decorations/themes, or
7073
/// override the standard sign-in widget with a custom implementation.
7174
///

0 commit comments

Comments
 (0)