From 662da02a0d7dcf608a3d9c4ef693a652c8f64ff0 Mon Sep 17 00:00:00 2001
From: woxtu <woxtup@gmail.com>
Date: Thu, 15 Mar 2018 01:56:24 +0900
Subject: [PATCH] Update README

---
 README.md | 22 ++++++++++++++++------
 1 file changed, 16 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 2b023a1..063002a 100644
--- a/README.md
+++ b/README.md
@@ -2,12 +2,14 @@
 
 Type-safe URL routing for Swift.
 
+## Usage
+
 ```swift
 struct UserIndex : Route {
     let path = "/users"
 
-    func map(to url: URL, parameters: [String : String], queries: [String : String]) {
-        print("user index")
+    func map(to url: URL, parameters: [String : String], queries: [String : String]) -> UIViewController {
+        return UserIndexViewController()
     }
 }
 
@@ -18,16 +20,24 @@ struct UserDetail : Route {
         let id: Int
     }
 
-    func map(to url: URL, parameters: Parameters, queries: [String : String]) {
-        print("user detail: \(parameters.id)")
+    func map(to url: URL, parameters: Parameters, queries: [String : String]) -> UIViewController {
+        return UserDetailViewController(id: parameters.id)
     }
 }
 
-let router = Router<Void>()
+// Use `Navigator` (for iOS)
+Navigator.append(route: UserIndex())
+Navigator.append(route: UserDetail())
+
+Navigator.push(url: URL(string: "/users/42")!, animated: true)
+Navigator.present(url: URL(string: "/users/42")!, animated: true)
+
+// Use `Router`
+let router = Router<UIViewController>()
 router.append(route: UserIndex())
 router.append(route: UserDetail())
 
-router.push(url: URL(string: "/users/42")!) // user detail: 42
+router.push(url: URL(string: "/users/42")!) // Return `UserDetailViewController`
 ```
 
 ## License