Skip to content

Commit e2f4aa6

Browse files
committed
Updated Readme
1 parent 5a91415 commit e2f4aa6

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# UIViewController-DisplayInDrawer
2-
Present any view controller easily in a drawer (iOS Maps style)
2+
Present any view controller easily in a drawer (iOS Maps style).
3+
4+
It is implemented as a UIViewController category, which means **no subclassing** and **no invasive view hierarchy setup**.
5+
It is designed to be as easy to use as possible:
6+
1. You can present any existing or new controller. Make it conform to the `DrawerConfiguration` protocol
7+
1. Optionally setup a `DrawerPositionDelegate` which is notified about drawer's position
8+
1. Call `displayInDrawer(controller, drawerPositionDelegate: delegate)`.
9+
10+
Amongst other things we add blur behind your controller. If you want blur effect to be visible you need give your viewController's view transparent background.
311

412
[![CI Status](https://img.shields.io/travis/vilemkurz/UIViewController-DisplayInDrawer.svg?style=flat)](https://travis-ci.org/vilemkurz/UIViewController-DisplayInDrawer)
513
[![Version](https://img.shields.io/cocoapods/v/UIViewController-DisplayInDrawer.svg?style=flat)](https://cocoapods.org/pods/UIViewController-DisplayInDrawer)
@@ -8,10 +16,12 @@ Present any view controller easily in a drawer (iOS Maps style)
816

917
## Example
1018

11-
To run the example project, clone the repo, and run `pod install` from the Example directory first.
19+
To see it in action run `pod try UIViewController-DisplayInDrawer` or clone the lib manually
1220

1321
## Requirements
1422

23+
iOS 10+
24+
1525
## Installation
1626

1727
UIViewController-DisplayInDrawer is available through [CocoaPods](https://cocoapods.org). To install
@@ -28,4 +38,3 @@ vilemkurz, [email protected]
2838
## License
2939

3040
UIViewController-DisplayInDrawer is available under the MIT license. See the LICENSE file for more info.
31-

0 commit comments

Comments
 (0)