index : olm

My fork of libolm

diff options
context:
space:
mode:
authorHubert Chathi <[email protected]>2020-05-13 19:05:19 -0400
committerHubert Chathi <[email protected]>2020-05-13 19:05:19 -0400
commit05a7af8db165f23eddf26f1eabb9a4c8c3ab3144 (patch)
tree5191d6e662c28b6181c3e331db4c155293f467c4
parent281c5aac212560ab791323c10c776461b6c9cbd6 (diff)
downloadolm-05a7af8db165f23eddf26f1eabb9a4c8c3ab3144.tar.gz
add a note about calling Olm.init
-rw-r--r--javascript/README.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/javascript/README.md b/javascript/README.md
index 6ed9bbb..d2f1d72 100644
--- a/javascript/README.md
+++ b/javascript/README.md
@@ -1,6 +1,9 @@
Olm
===
+Note: before using any of the olm functions, you must call `Olm.init()`, and
+wait for the promise to resolve.
+
Example:
var alice = new Olm.Account();