Skip to content

Commit 42e3d0b

Browse files
committed
remove warning from README (installation does work)
1 parent ed2bd49 commit 42e3d0b

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,18 @@ It's still an early work in progress, only superficially tested, and not by any
1313

1414
Do feel free to try it out, leave feedback and/or provide suggestions :)
1515

16-
PLUGIN INSTALLATION DOES NOT WORK YET - will be sorted in the coming days
17-
1816
## Usage:
1917

2018
### To configure a component so that it can be navigated to:
2119
`src/pages/foo.ts`
22-
20+
2321
This:
2422

2523
```
2624
@routable()
2725
export class FooPage {}
2826
```
29-
27+
3028
Will generate the following `RouteConfig`:
3129

3230
```
@@ -39,14 +37,14 @@ PLUGIN INSTALLATION DOES NOT WORK YET - will be sorted in the coming days
3937
settings: {}
4038
}
4139
```
42-
40+
4341
This:
4442

4543
```
4644
@routable({route: ["", "foo"]}) // pass in any RouteConfig properties to override the defaults
4745
export class FooPage {}
4846
```
49-
47+
5048
Will generate the following `RouteConfig`:
5149

5250
```
@@ -59,7 +57,7 @@ PLUGIN INSTALLATION DOES NOT WORK YET - will be sorted in the coming days
5957
settings: {}
6058
}
6159
```
62-
60+
6361
This:
6462

6563
```
@@ -68,7 +66,7 @@ PLUGIN INSTALLATION DOES NOT WORK YET - will be sorted in the coming days
6866
public static title = "The Foo Page"; // static properties on the class that match RouteConfig property names will also override the defaults
6967
}
7068
```
71-
69+
7270
Will generate the following `RouteConfig`:
7371

7472
```
@@ -85,7 +83,7 @@ PLUGIN INSTALLATION DOES NOT WORK YET - will be sorted in the coming days
8583

8684
### To configure a component so that its router configuration will be mapped:
8785
`src/app.ts`
88-
86+
8987
This:
9088

9189
```
@@ -96,7 +94,7 @@ PLUGIN INSTALLATION DOES NOT WORK YET - will be sorted in the coming days
9694
])
9795
export class App {}
9896
```
99-
97+
10098
Will assign a `configureRouter` method (if none is present) or proxy the existing (if already present), to do the following:
10199

102100
```
@@ -121,7 +119,7 @@ PLUGIN INSTALLATION DOES NOT WORK YET - will be sorted in the coming days
121119
])
122120
}
123121
```
124-
122+
125123

126124

127125

0 commit comments

Comments
 (0)