fix: documentation

impaktfull · Feb 11, 2024 · 77bc2a1 · 77bc2a1
1 parent de756e8
commit 77bc2a1
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,17 +1,22 @@
+# 0.0.14
+
+## Fix
+- Better documentation in the `README.md` about the `SnackyNavigationObserver`
+
 # 0.0.12 - 0.0.13
 
-## Feat
+## Fix
 - Extra documentation in the `README.md`
 
 # 0.0.10 - 0.0.11
 
-## Feat
+## Fix
 - Automated builds using GitHub Actions
 - Added preview video to the `README.md`
 
 # 0.0.4 - 0.0.9
 
-## Feat
+## Fix
 - Added `Snacky` logo to the `README.md`
 
 # 0.0.3

diff --git a/README.md b/README.md
@@ -19,6 +19,11 @@ Widget build(BuildContext context) {
     return SnackyConfiguratorWidget(
         app: MaterialApp(
             ...
+            // Optional if you want to close snackies on push/replacement
+            navigatorObservers: [
+                SnackyNavigationObserver(),
+            ],
+            ...
         ),
     );
 }

diff --git a/example/lib/main.dart b/example/lib/main.dart
@@ -22,6 +22,9 @@ class MyApp extends StatelessWidget {
           colorScheme: ColorScheme.fromSeed(seedColor: colorAccent),
           useMaterial3: true,
         ),
+        navigatorObservers: [
+          SnackyNavigationObserver(),
+        ],
         home: const HomeScreen(),
       ),
     );