From 92dee3d8c8ec2cb64e87928a4bc271b45a269b12 Mon Sep 17 00:00:00 2001 From: Muzammil Khaja Mohammed Date: Wed, 5 Dec 2018 19:56:14 +0530 Subject: [PATCH] updating documentation --- README.md | 13 ++++++++++++- package.json | 2 +- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bf83ddb..92d4b98 100644 --- a/README.md +++ b/README.md @@ -131,7 +131,18 @@ $.when($.ready) * On Initial load, Navigate to a route. ### Events -There are about 6 events, you can listen to these events or subscribe to events via router. +There are about 6 events, you can listen to these events or subscribe to events via router. Events are triggered in the following order. + +#### Event Trigger Order +If Route Matched: +```javascript + onRouteMatched -> onRouteBeforeChange -> onViewDestroyed -> onViewChange -> onRouteChanged +``` + +If Route Not Matched: +```javascript + onRouteNotMatched +``` ##### This event is trigged when view is loaded in to dom & either controller or viewmodel can be initiated. * Window Event diff --git a/package.json b/package.json index 80e2ba9..58c1306 100644 --- a/package.json +++ b/package.json @@ -33,7 +33,7 @@ "bugs": { "url": "https://github.com/muzammilkm/jq-router/issues" }, - "homepage": "https://github.com/muzammilkm/jq-router#readme", + "homepage": "https://muzammilkm.github.io/jq-router", "dependencies": { "gulp": "^3.9.1", "jquery": "^3.2.1"