diff --git a/README.md b/README.md index 6ab6a7414..0dc6b63d0 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,7 @@ Then, follow the steps as described in Carthage's [README](https://github.com/Ca ## Basic Usage -To get started, this is a simple usage sample. +To get started, this is a simple usage sample of using the integrated view controller. ```swift import FolioReaderKit @@ -68,6 +68,19 @@ func open(sender: AnyObject) { } ``` +You can also use your own FolioReader view controller like this. + +```swift + let config = FolioReaderConfig() + + let bookPath = NSBundle.mainBundle().pathForResource("book", ofType: "epub") + let epubVC = FolioReaderContainer(config: config, epubPath: bookPath, removeEpub: true) + FolioReader.sharedInstance.readerContainer = epubVC + + // present the epubVC view controller like every other UIViewController instance + self.presentViewController(epubVC, animated: true, completion: nil) +``` + In your AppDelegate call `applicationWillResignActive` and `applicationWillTerminate`. This will save the reader state even if you kill the app. ```swift @@ -96,7 +109,7 @@ func applicationWillTerminate(application: UIApplication) { - [x] Media Overlays (Sync text rendering with audio playback) - [x] TTS - Text to Speech Support - [x] Parse epub cover image -- [x] Vertical and Horizontal scrolling +- [x] Vertical or/and Horizontal scrolling - [x] RTL Support - [ ] PDF support - [ ] Book Search