dnrops
/
RouteKit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README

This commit is contained in:
woxtu 2018-03-15 01:56:24 +09:00
parent fbdeb5b52d
commit 662da02a0d
1 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -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