Skip to content
This repository has been archived by the owner on Jul 22, 2024. It is now read-only.

Commit

Permalink
Update the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
[email protected] committed Feb 20, 2022
1 parent 23324d7 commit e173a9e
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This is a Go package implementing the TextSecure **push data** (i.e. not encrypt

The included sample command line app can send and receive text messages and attachments and supports group chat.

**The API presented by the package is in flux**, mainly driven by the needs of https://github.com/nanu-c/textsecure-qml
**The API presented by the package is in flux**, mainly driven by the needs of https://github.com/nanu-c/axolotl

Automatically generated documentation can be found on [GoDoc](https://pkg.go.dev/github.com/signal-golang/textsecure)

Expand All @@ -15,6 +15,7 @@ This command will install both the library and the test client.

go get github.com/signal-golang/textsecure/cmd/textsecure

textsecure also depends on [crayfish](https://github.com/nanu-c/crayfish) which is a Go library for interacting with the upstream [libsignal-client](https://github.com/signalapp/libsignal-client) library. It's currently used for registration and decryption of messages. libzkgroup is used for the groupv2 protocol and is add by [this go wrapper] (https://github.com/nanu-c/zkgroup). It has to be added to the `LD_LIBRARY_PATH` environment variable. Crayfish is built with `cago build` and has to be placed next to the `textsecure` binary.

Configuration
-------------
Expand Down

0 comments on commit e173a9e

Please sign in to comment.