From 4d0e084cf2df7d4b851b4d8bd1f65140bc9a7403 Mon Sep 17 00:00:00 2001 From: Morgan Date: Tue, 2 May 2023 08:27:27 -0500 Subject: [PATCH] refactor: update readme --- README.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 28f5902..d952e64 100644 --- a/README.md +++ b/README.md @@ -120,8 +120,6 @@ final routes = GoRouter( ### Navigate to your paths -Go router is used in this example, but is not required. - ```dart AppPaths.home.path // '/home' AppPaths.welcome.login.path // '/welcome/login' @@ -133,14 +131,12 @@ AppPaths.users.user.define('Darth Vader').delete.path // '/users/Darth Vader/del AppPaths.books.define('Star Wars').query({'first-trilogy-only': 'true'}).path // '/books/Star Wars?first-trilogy-only=true' ``` -## Note - -### Encoding +## Encoding -Calling the `path` member on a `Path` or `Param` will return the path as an encoded string automatically, including all params and queries. +All params and query params (keys and values) are encoded using `Uri.encodeComponent`. [go_router]: https://pub.dev/packages/go_router [license_badge]: https://img.shields.io/badge/license-MIT-blue.svg [license_link]: https://opensource.org/licenses/MIT [very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg -[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis \ No newline at end of file +[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis