diff --git a/README.md b/README.md index c51ca5b2d..5c549062b 100644 --- a/README.md +++ b/README.md @@ -236,6 +236,24 @@ host the API reference from the source files like this: Then visit ``http://localhost:8005`` to see the API docs. +End-to-end encryption support +============================= + +The SDK supports end-to-end encryption via the Olm and Megolm protocols, using +[libolm](http://matrix.org/git/olm). It is left up to the application to make +libolm available, via the ``Olm`` global. + +To enable support in a browser application: + + * download the transpiled libolm (either via ``npm install olm``, or from + https://matrix.org/packages/npm/olm/). + * load ``olm.js`` as a ``