Updated README

This commit is contained in:
Kieran Lafferty
2013-08-06 21:07:10 -04:00
parent f4b28d5363
commit 4d06bbbf9f
2 changed files with 10 additions and 1 deletions

View File

@@ -5,7 +5,7 @@ KLCircleViewController
A control that allows panning between view controllers as inspired by the Circle app.
Note: KLCircleViewController is intended for use with portrait orientation on iPhone/iPod Touch.
Note: KLCircleViewController is intended for use with portrait orientation on iPhone/iPod Touch/iPad.
Requires ARC
@@ -46,6 +46,15 @@ To invalidate/remove a view controller after instantiation set the property to n
Note: As mentioned above, this can not be done for the center view controller as it is required.
## Reference to KLCircleViewController from child View Controllers ##
A category has been added to UIViewController that allows any UIViewController to access the KLCircleViewController from within the child. This reference will only exist for the span of time that the child is truly contained within the KLCircleViewController instance. If the KLCircleViewController removes the UIViewController then it can no longer be referenced and will return nil.
#import "KLCircleViewController.h"
...
KLCircleViewController circleController = self.circleController;
//Do whatever useful things you may need to do with this reference here
## Registering for callbacks ##
Callbacks are all handled by blocks.