⚠️ ᴛʜɪs ʀᴇᴘᴏsɪᴛᴏʀʏ ɪs ᴅᴇᴘʀᴇᴄᴀᴛᴇᴅ ⚠️

We moved all the r2-*-swift modules to a single repository: swift-toolkit.

r2-shared-swift

Contains the definitions of the custom types (model) used across the Readium 2 Swift projects.

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 R2Shared with Carthage:

1. Make sure Carthage is installed.

2. Update your Cartfile to include the following:

   github "readium/r2-shared-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 R2Shared