Skip to content

Latest commit

 

History

History
62 lines (47 loc) · 1.8 KB

README.md

File metadata and controls

62 lines (47 loc) · 1.8 KB

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

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
  • Unzip and parse ePub files
  • Book Search
  • Add Notes to a Highlight
  • Write Some Tests
  • Better Documentation

Demo

Custom Fonts 😏

Custom fonts

Day and Night Mode 😎

Day night mode

Text Highlighting 😍

Highlight

Reading Time Left 😮

Time left

Installation

FolioReaderKit is available through CocoaPods. To install it, simply add the following lines to your Podfile:

use_frameworks!
pod 'FolioReaderKit'

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)
}

License

FolioReaderKit is available under the GNU General Public license. See the LICENSE file for more info.