Merge pull request #43 from matrix-org/pedroc/android_e2e_dev

Android wrappers for olm library

1 files changed, 29 insertions, 0 deletions

diff --git a/android/README.rst b/android/README.rst
new file mode 100644
index 0000000..46beaab
--- /dev/null
+++ b/android/README.rst
@@ -0,0 +1,29 @@
+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 ``android/`` path.
+
+The project contains some JNI files and some Java wraper files.
+
+The project contains some tests under AndroidTests package.