aboutsummaryrefslogtreecommitdiff
path: root/java/android/OlmLibSdk/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'java/android/OlmLibSdk/README.rst')
-rw-r--r--java/android/OlmLibSdk/README.rst26
1 files changed, 26 insertions, 0 deletions
diff --git a/java/android/OlmLibSdk/README.rst b/java/android/OlmLibSdk/README.rst
new file mode 100644
index 0000000..049eed8
--- /dev/null
+++ b/java/android/OlmLibSdk/README.rst
@@ -0,0 +1,26 @@
+OlmLibSdk
+=========
+
+OlmLibSdk exposes An android wrapper to libolm.
+
+
+Installation
+------------
+ Create a libs directory in your project directory
+ Copy the olm-sdk.aar into it.
+ In your build.gradle file, add in the android section
+ repositories {
+ flatDir {
+ dir 'libs'
+ }
+ }
+ Add in the dependencies category
+ compile(name: 'olm-sdk', ext: 'aar')
+
+Development
+-----------
+import the project from the /java/android/OlmLibSdk path.
+
+The project contains some JNI files and some Java wraper files.
+
+The project contains some tests under AndroidTests package. \ No newline at end of file