diff options
| author | Richard van der Hoff <github@rvanderhoff.org.uk> | 2016-10-20 11:42:09 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-10-20 11:42:09 +0100 |
| commit | 68d98234e1cfd2893f58c41022ae169ce59b8f3c (patch) | |
| tree | 918a42af0ce2def599b6812c0faca0c780de26d0 /README.rst | |
| parent | d48dc8197680dce2bb810c5714f17d1a35dcb3d0 (diff) | |
| parent | df04cd509a13fb1a3c8b953de4f987b15fcde9b1 (diff) | |
Merge pull request #30 from matrix-org/rav/misc_docs
Add notes on limitations to megolm spec
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 8 |
1 files changed, 6 insertions, 2 deletions
@@ -5,8 +5,12 @@ An implementation of the Double Ratchet cryptographic ratchet described by https://github.com/trevp/double_ratchet/wiki, written in C and C++11 and exposed as a C API. -The specification of the Olm ratchet can be found in docs/olm.rst or -https://matrix.org/docs/spec/olm.html +The specification of the Olm ratchet can be found in ``docs/olm.rst`` or +https://matrix.org/docs/spec/olm.html. + +This library also includes an implementation of the Megolm cryptographic +ratchet, as specified in ``docs/megolm.rst`` or +https://matrix.org/docs/spec/megolm.html. Building -------- |