Skip to content

Latest commit

 

History

History
119 lines (87 loc) · 5.94 KB

README.md

File metadata and controls

119 lines (87 loc) · 5.94 KB
Raw

FolioReader logo FolioReaderKit is an ePub reader and parser framework for iOS written in Swift.

Installation

FolioReaderKit is available through CocoaPods and Carthage.

Cocoapods

To install it, simply add the following lines to your Podfile:

use_frameworks!
pod 'FolioReaderKit'

Carthage

  1. Add the following to your Cartfile

    github "FolioReader/FolioReaderKit"

  2. Run carthage update and follow the steps as described in Carthage's README.

Requirements

  • iOS 8.0+
  • Xcode 7.1+

Basic Usage

To get started, this is a simple usage sample.

import FolioReaderKit

func open(sender: AnyObject) {
    let config = FolioReaderConfig()
    let bookPath = NSBundle.mainBundle().pathForResource("book", ofType: "epub")
    FolioReader.presentReader(parentViewController: self, withEpubPath: bookPath!, andConfig: config)
}

In your AppDelegate call applicationWillResignActive and applicationWillTerminate. This will save the reader state even if you kill the app.

import FolioReaderKit

func applicationWillResignActive(application: UIApplication) {
    FolioReader.applicationWillResignActive()
}

func applicationWillTerminate(application: UIApplication) {
    FolioReader.applicationWillTerminate()
}

Features

  • Custom Fonts
  • Custom Text Size
  • Text Highlighting
  • List / Edit / Delete Highlights
  • Themes / Day mode / Night mode
  • Handle Internal and External Links
  • Portrait / Landscape
  • Reading Time Left / Pages left
  • In-App Dictionary
  • Media Overlays (Sync text rendering with audio playback)
  • TTS - Text to Speech Support
  • Parse epub cover image
  • PDF support
  • Book Search
  • Add Notes to a Highlight
  • Better Documentation

Demo

Custom Fonts 😏

Custom fonts

Day and Night Mode 😎

Day night mode

Text Highlighting 😍

Highlight

Reading Time Left 😮

Time left

Media Overlays 😭

Time left

Documentation

For now the documentation is the sample project, I will write a better documentation in the next weeks.

You have a problem that cannot be solved by having a look at the example project? No problem, let's talk: Join the chat at https://gitter.im/FolioReader/FolioReaderKit

Author

Heberti Almeida

Donations

This project needs you! If you would like to support this project's further development, the creator of this project or the continuous maintenance of this project, feel free to donate. Your donation is highly appreciated. Thank you!

PayPal

License

FolioReaderKit is available under the BSD license. See the LICENSE file.