aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-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();