From 2ca2c8e3faed5bfa82c299809551485be3c823f1 Mon Sep 17 00:00:00 2001 From: Ox Cart Date: Tue, 11 May 2021 16:24:48 -0500 Subject: [PATCH] Added introduction to README --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index b901e23..9e06962 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,15 @@ # messaging-android +This library provides an API to facilitate secure end-to-end encrypted messaging on Android devices, +backed by a [fork of libsignal](https://github.com/getlantern/libsignal-protocol-java/) and +communicating via a [tassis](https://github.com/getlantern/tassis) messaging server. + +messaging-android is currently used in [Lantern](https://lantern.io/) but is intended to be usable +by other parties in their own clients. tassis will eventually support federation, such that 3rd +parties can host their own back end and interoperate with other messaging clients. ## Data Model +messaging-android stores data in an [encrypted key-value store](https://github.com/getlantern/db-android/) +using keys that follow the below convention. ### /me The contact entry for the user themselves.