@ngrdt/router 0.0.2 → 0.0.4

package/README.md

@@ -1,7 +1,52 @@
 # @ngrdt/router
 
-This library was generated with [Nx](https://nx.dev).
+### Instalation
+```npm install @ngrdt/router```
 
-## Running unit tests
+### Define Route
+```javascript
+export const COOL_ROUTE = new RdtRouteBuilder()
+  .setName('Cool Route')
+  .setPath('cool-route')
+  .setCanBeEntered(() => inject(MockPermissionService).hasPermission('COOL_ACCESS'))
+  .build();
+```
 
-Run `nx test @ngrdt/router` to execute the unit tests.
+### Define Child Route
+```javascript
+export const COOL_ROUTE_CHILD = new RdtRouteBuilder()
+  .setName('Cool Route child')
+  .setPath(':coolId')
+  .setCanBeEntered(() => inject(MockPermissionService).hasPermission('COOL_CHILD_ACCESS'))
+  .build();
+
+PARENT_ROUTE
+.setChildren(COOL_ROUTE_CHILD)
+```
+
+### Define Angular Route
+```javascript
+// Create angular route
+COOL_ROUTE.toAngularRoute()
+  .setComponent(RouteLevel1Component)
+  .build()
+
+// Get information of route
+COOL_ROUTE.name
+```
+### Use It in template
+```html
+<button [rdtRouterLink]="COOL_ROUTE" [params]="{ coolId: 123 }">
+  Go to Level 2
+</button>
+```
+
+### See other cool features like
+```javascript
+private readonly rdtRouter: RdtRouterService = inject(Dp3RouterService);
+
+rdtRouter.navigate(...);
+rdtRouter.parseAbsoluteUrl(...);
+rdtRouter.navigateBack(...);
+...
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ngrdt/router",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "peerDependencies": {
     "@angular/common": "^18.2.0",
     "@angular/core": "^18.2.0",