aboutsummaryrefslogtreecommitdiff
path: root/xcode/README.rst
blob: db78e57bdbe2316f1e5b18d7ce2edad727953f33 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
OLMKit
======

OLMKit exposes an Objective-C wrapper to libolm.

The original work by Chris Ballinger can be found at https://github.com/chrisballinger/OLMKit.

Installation
------------
You can embed OLMKit to your application project with CocoaPods. The pod for
the latest OLMKit release is::

    pod 'OLMKit'

Development
-----------
Run `pod install` and open `OLMKit.xcworkspace`.

The project contains only tests files. The libolm and the Objective-C wrapper source files are loaded via the OLMKit CocoaPods pod.

To add a new source file, add it to the file system and run `pod update` to make CocoaPods insert into OLMKit.xcworkspace.