From 86ab070466ddcdb0d7d058ca996c191eadb858da Mon Sep 17 00:00:00 2001 From: hlineholm-flir <30647165+hlineholm-flir@users.noreply.github.com> Date: Thu, 26 Oct 2017 08:00:44 +0200 Subject: [PATCH] Add info about how the get started --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 3d6af68..4916a56 100644 --- a/README.md +++ b/README.md @@ -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