/olm-ex

Elixir/Erlang wrapper for the olm and megolm cryptographic ratchets

Primary LanguageElixir

Olm

Elixir wrapper for Olm.

Installation

Install Olm

Olm is a native C library. The library is packaged by several distributions.

On Debian one can install it like so:

apt install libolm-dev

On Darwin:

brew install libolm

NOTE: one must set the ERL_ROOT environment var, usually /usr/local/lib/erlang/erts-version

If available in Hex, the package can be installed by adding olm to your list of dependencies in mix.exs:

def deps do
  [
    {:olm, "~> 0.1.0"}
  ]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/olm.