README.md

r2-navigator-swift

A Swift implementation of the R2 Navigator

Changes and releases are documented in the Changelog

Adding the library to your iOS project

Note: requires Swift 4.2 (and Xcode 10.1).

Carthage

Carthage is a simple, decentralized dependency manager for Cocoa. To install R2Navigator with Carthage:

1. Make sure Carthage is installed.

2. Update your Cartfile to include the following:

   github "readium/r2-navigator-swift" "develop"

3. Run:

   • mkdir -p Carthage/Build/iOS
   • carthage update --use-xcframeworks

4. Add the appropriate framework.

Import

In your Swift files :

// Swift source file

import R2Navigator

Dependencies in this module

• R2Shared : Contains the definitions of shared custom types used across the readium-2 Swift projects.