aboutsummaryrefslogtreecommitdiff
path: root/libraries/olm/README
diff options
context:
space:
mode:
authorDavid O'Shaughnessy <dev@osh.id.au>2020-01-03 15:05:20 -0600
committerWilly Sudiarto Raharjo <willysr@slackbuilds.org>2020-01-12 08:47:58 +0700
commitbd5476c7609004e3f6213982d9f1c3041aa76c20 (patch)
tree5e0677f6d889ea1650d717862c4d3860eb340191 /libraries/olm/README
parentafeec61f7f13fc92c1362fc55e83244ea46a6609 (diff)
libraries/olm: Added (olm and megolm cryptographic ratchets)
Signed-off-by: Robby Workman <rworkman@slackbuilds.org>
Diffstat (limited to 'libraries/olm/README')
-rw-r--r--libraries/olm/README18
1 files changed, 18 insertions, 0 deletions
diff --git a/libraries/olm/README b/libraries/olm/README
new file mode 100644
index 0000000000..fcdee97450
--- /dev/null
+++ b/libraries/olm/README
@@ -0,0 +1,18 @@
+olm (olm and megolm cryptographic ratchets)
+
+An implementation of the Double Ratchet cryptographic ratchet described by
+https://whispersystems.org/docs/specifications/doubleratchet/, written in
+C and C++11 and exposed as a C API.
+
+The specification of the Olm ratchet can be found in olm.md.
+
+This library also includes an implementation of the Megolm cryptographic
+ratchet, as specified in megolm.md.
+
+Olm is designed to be easy port to different platforms and to be easy to
+write bindings for.
+
+It was originally implemented in C++, with a plain-C layer providing the
+public API. As development has progressed, it has become clear that C++
+gives little advantage, and new functionality is being added in C, with
+C++ parts being rewritten as the need arises.