From 270746daf4dcc391f5683439ba5570dac7f0590d Mon Sep 17 00:00:00 2001 From: nworbnhoj Date: Thu, 7 Dec 2023 18:10:06 +1100 Subject: [PATCH] update sigchat readme --- apps/sigchat/README.md | 2 +- apps/sigchat/src/manager/README.md | 9 +++++++++ 2 files changed, 10 insertions(+), 1 deletion(-) create mode 100644 apps/sigchat/src/manager/README.md diff --git a/apps/sigchat/README.md b/apps/sigchat/README.md index 41f2d0e52..d7e3f2f3b 100644 --- a/apps/sigchat/README.md +++ b/apps/sigchat/README.md @@ -1,4 +1,4 @@ -# mtxchat +# sigchat This is the skeleton of a Signal chat application. diff --git a/apps/sigchat/src/manager/README.md b/apps/sigchat/src/manager/README.md new file mode 100644 index 000000000..1442edf31 --- /dev/null +++ b/apps/sigchat/src/manager/README.md @@ -0,0 +1,9 @@ +The structure of the Signal interface is modelled on [signal-cli](https://github.com/AsamK/signal-cli) by AsamK and contributors. signal-cli is a command-line interface for libsignal-service-java. It supports registering, verifying, sending and receiving messages. This development provides a welcome road-map of the various common transactions between a Signal client and server - see the signal-cli [Manual Page](https://github.com/AsamK/signal-cli/blob/master/man/signal-cli.1.adoc). This road-map is sketched out in apps/sigchat/src/manager.rs, but will be subject to refinement as sigchat development progresses. + +Manager::methods() will likely make calls on the official [libsignal](https://github.com/signalapp/libsignal#overview) library. + +> libsignal contains platform-agnostic APIs used by the official Signal clients and servers, exposed as a Java, Swift, or TypeScript library. The underlying implementations are written in Rust. + +> This repository is used by the Signal client apps ([Android](https://github.com/signalapp/Signal-Android), [iOS](https://github.com/signalapp/Signal-iOS), and [Desktop](https://github.com/signalapp/Signal-Desktop)) as well as server-side. Use outside of Signal is unsupported. + +libsignal is released under the AGPLv3 licence, and therefore not directly compatible with xous released under the MIT license. Therefore, libsignal must be wrapped in a suitable API, and included as a binary in the hardware image.