docs(All): 添加使用说明

Author: wxlpp

Example/shell/MainViewController.swift

@@ -32,5 +32,6 @@ class MainViewController: UITableViewController {
     override func tableView(_ tableView: UITableView, didSelectRowAt indexPath: IndexPath) {
         tableView.deselectRow(at: indexPath, animated: true)
         UIApplication.shared.route(url: routes[indexPath.row].path).push()
+        UIApplication.shared.route(url: routes[indexPath.row].path).presentWithNavigationController(UINavigationController.self)
     }
 }

README.md

@@ -5,7 +5,7 @@
 ![Bitbucket open issues](https://img.shields.io/bitbucket/issues/wxlpp/UIRouter)
 
 UIRouter 是一个用Swift实现的路由解耦框架.
-
+[API文档](https://wxlpp.github.io/UIRouter/)
 ## 安装
 
 ### CocoaPods
@@ -18,7 +18,79 @@ pod 'UIRouter', '~> 0.1.0.alpha'
 
 ```swift
 dependencies: [
-    .package(url: "https://github.com/Alamofire/Alamofire.git", .upToNextMajor(from: "5.2.0"))
+    .package(url: "https://github.com/Alamofire/Alamofire.git", .upToNextMajor(from: "0.1.0"))
 ]
 ```
 ## 使用
+
+### 页面注册
+
+```swift
+import UIKit
+import UIRouter
+
+@main
+class AppDelegate: UIResponder, UIApplicationDelegate {
+
+    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
+        // 可以在此调用 autoRegisterIfNeed 进行页面预注册，否则会在第一次页面路由发生时进行注册
+        application.router.autoRegisterIfNeed()
+        // 注册拦截器，WebInterceptor 是一个默认实现的 htttp 协议拦截器
+        application.router.register(interceptors: [WebInterceptor()])
+        // 注册错误处理器进行错误处理
+        application.router.registerErrorHandler(RouteErrorHandler())
+        return true
+    }
+}
+
+```
+
+```swift
+import UIKit
+import UIRouter
+
+public final class UserProfileViewController: UIViewController {}
+
+// MARK: 路由
+
+extension UserProfileViewController: Routable {
+    public static func route(parameters: RouterParameters, completion: @escaping RouteCompletionHandler<UserProfileViewController>) {
+        // 对参数进行验证，成功返回 ViewController,失败则返回错误，
+        // 这里返回的是参数验证错误，也可以返回业务自定义错误。
+        if let userID: String = parameters.get("name") {
+            completion(.success(UserProfileViewController()))
+        } else {
+            completion(.failure(RouteError.parameterValidationFailed(url: path, name: "name")))
+        }
+    }
+
+    public static var path: String {
+        "user/profile/:id"
+    }
+}
+```
+### 页面路由
+```swift
+UIApplication.shared.route(url: "user/profile/123456?name=wxlpp").push()
+UIApplication.shared.route(url: "https://github.com/wxlpp/UIRouter").present()
+UIApplication.shared.route(url: "flutter://shop.com/home").presentWithNavigationController(UINavigationController.self)
+```
+### 错误拦截
+```swift
+import UIRouter
+
+class RouteErrorHandler: RouteErrorHandling {
+    func handleRouteError(_ error: RouteError) {
+        #if DEBUG
+            let vc = ErrorDetailsViewController(error: error)
+            UIApplication.shared.route(viewcontroller: vc).presentWithNavigationController(UINavigationController.self)
+        #else
+            debugPrint(error.errorDescription)
+        #endif
+    }
+
+    func handleCustomError(_ error: Error) {
+        //这里对业务错误信息进行处理，比如用户鉴权失败弹出登录页面
+    }
+}
+```