Skip to content

Commit 286c880

Browse files
committed
Update README.md
1 parent a685998 commit 286c880

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,14 @@ A view router library for Flutter apps.
44

55
## Features
66

7-
TODO
7+
Parses named routes and provides named parameters and query parameters as arguments for widget building.
8+
9+
| Route | Config | Result |
10+
| ------------------------ | ----------------- | -------------------------------------------------------------------- |
11+
| `/` | `/` | `{name: '/', params: {}}` |
12+
| `/items?item_id=123` | `/items` | `{name: '/items', params: {'item_id': '123'}}` |
13+
| `/items/123` | `/items/:item_id` | `{name: '/items/123', params: {'item_id': '123'}}` |
14+
| `/items/123?tab=details` | `/items/:item_id` | `{name: '/items/123', params: {'item_id': '123', 'tab': 'details'}}` |
815

916
## Getting started
1017

@@ -16,8 +23,6 @@ view_router:
1623
url: git://github.com/brookesb91/view_router.git
1724
```
1825
19-
## Usage
20-
2126
### Basic Usage
2227
2328
Define your view routes.
@@ -97,7 +102,3 @@ Navigating to a route with query parameters.
97102
```dart
98103
Navigator.of(context).pushNamed('/items?item_id=${item.id}');
99104
```
100-
101-
## Additional information
102-
103-
TODO

0 commit comments

Comments
 (0)