Skip to content
This repository has been archived by the owner on Nov 26, 2020. It is now read-only.
/ FolioReaderKit Public archive

📚 A Swift ePub reader and parser framework for iOS.

License

Notifications You must be signed in to change notification settings

FolioReader/FolioReaderKit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

99 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FolioReader 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

Requirements

  • iOS 8.0+
  • Xcode 7.1+

Installation

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

use_frameworks!
pod 'FolioReaderKit'

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.