diff options
Diffstat (limited to 'xcode/README.rst')
| -rw-r--r-- | xcode/README.rst | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/xcode/README.rst b/xcode/README.rst new file mode 100644 index 0000000..d56fa85 --- /dev/null +++ b/xcode/README.rst @@ -0,0 +1,26 @@ +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 it into OLMKit.xcworkspace. + +Release +------- +See ../README.rst for the release of the CocoaPod. + |