Skip to content

Commit

Permalink
Add info about how the get started
Browse files Browse the repository at this point in the history
  • Loading branch information
hlineholm-flir authored and Henrik Lineholm committed Oct 26, 2017
1 parent ca1bb0a commit 86ab070
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
# RoutableUIKit
Routable UIKit components which are agnostic of you custom routing logic
## Getting Started
### RoutableNavigationController (RNC) and RoutableNavigationControllerDelegate (RNCD)
1. Create an instance of the navigation controller
2. Conform to the RNCD and set the routing delegate of the instance you've created
3. Use the delegate methods to update your routing state:
- Read and write the route property of the RNC to synchronize it with your router
- Use the sender property of the RNC push/pop methods to detect who initiated the action
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

0 comments on commit 86ab070

Please sign in to comment.