v2.2.6: README updates

csells · Nov 11, 2021 · 739ea57 · 739ea57
1 parent ed4f924
commit 739ea57
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,12 @@
+### 2.2.6
+- [Fix 127](https://github.com/csells/go_router/issues/127): updated the README
+  to add a video overview of the project for people that prefer that media style
+  over long-form text when approaching a new topic
+- [Fix 108](https://github.com/csells/go_router/issues/108): updated the
+  description of the `state` parameter to clarfy that not all properties will be
+  set at every usage
+
+
 ### 2.2.5
 - [Fix 120 again](https://github.com/csells/go_router/issues/120): found the bug
   in my tests that was masking the real bug; changed two characters to implement

diff --git a/README.md b/README.md
@@ -35,6 +35,7 @@ easy-to-use developer experience.
 - [Changelog](#changelog)
 - [Migrating to 2.x](#migrating-to-2x)
 - [Getting Started](#getting-started)
+- [Video Overview](#video-overview)
 - [Declarative Routing](#declarative-routing)
   * [Router state](#router-state)
   * [Error handling](#error-handling)
@@ -167,6 +168,17 @@ and hopefully this change makes things a little more clear.
 To use the go_router package, [follow these
 instructions](https://pub.dev/packages/go_router/install).
 
+# Video Overview
+If you'd like to see a video overview of the go_router package, you can watch
+the following:
+
+[![Flutter Navigator 2.0 made easy with
+go_router](https://img.youtube.com/vi/G41NdhieUoc/0.jpg)](https://www.youtube.com/watch?v=G41NdhieUoc)
+
+In this video, I did some pair programming with Majid Hajian to port an existing
+Flutter app built using the original Navigation API to use go_router for both
+mobile and web.
+
 # Declarative Routing
 The go_router is governed by a set of routes which you specify as part of the
 `GoRouter` constructor:
@@ -230,6 +242,11 @@ current path for that page in the [stack of pages](#sub-routes), so it will
 uniquely identify the page w/o having to hardcode a key or come up with one
 yourself.
 
+Not all of the state parameters will be set every time. In general, the state is
+a superset of the potential current state of a `GoRouter` instance. For example,
+the `error` parameter will only be set of there's an error, the `params` won't
+be set during top-level direction because there's no `path` to match yet, etc.
+
 ## Error handling
 In addition to the list of routes, the go_router needs an `errorPageBuilder`
 function in case no page is found, more than one page is found or if any of the

diff --git a/example/pubspec.lock b/example/pubspec.lock
@@ -99,7 +99,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "2.2.5"
+    version: "2.2.6"
   js:
     dependency: transitive
     description:

diff --git a/example/pubspec.yaml b/example/pubspec.yaml
@@ -1,6 +1,6 @@
 name: go_router_examples
 description: go_router examples
-version: 2.2.5
+version: 2.2.6
 publish_to: none
 
 environment:

diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,7 +1,7 @@
 name: go_router
 description: A declarative router for Flutter based on Navigation 2 supporting
   deep linking, data-driven routes and more
-version: 2.2.5
+version: 2.2.6
 repository: https://github.com/csells/go_router
 
 environment: