X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/15b16f3dc326b63feaa3cbefc902121aeb59bb46..8ebca0d7fb37489e1b3109519b9ff76067295007:/README.md diff --git a/README.md b/README.md index dc2911b2..178573fe 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,10 @@ # signal-cli signal-cli is a commandline interface for [libsignal-service-java](https://github.com/WhisperSystems/libsignal-service-java). It supports registering, verifying, sending and receiving messages. -To be able to link to an existing Signal-Android/signal-cli instance, signal-cli uses a [patched libsignal-service-java](https://github.com/AsamK/libsignal-service-java), because libsignal-service-java does not yet support [provisioning as a slave device](https://github.com/WhisperSystems/libsignal-service-java/pull/21). +To be able to link to an existing Signal-Android/signal-cli instance, signal-cli uses a [patched libsignal-service-java](https://github.com/AsamK/libsignal-service-java), because libsignal-service-java does not yet support [provisioning as a linked device](https://github.com/WhisperSystems/libsignal-service-java/pull/21). For registering you need a phone number where you can receive SMS or incoming calls. signal-cli is primarily intended to be used on servers to notify admins of important events. For this use-case, it has a dbus interface ([man page](https://github.com/AsamK/signal-cli/blob/master/man/signal-cli-dbus.5.adoc)), that can be used to send messages from any programming language that has dbus bindings. +It also has a JSON-RPC based interface, see the [documentation](https://github.com/AsamK/signal-cli/wiki/JSON-RPC-service) for more information. ## Installation @@ -13,7 +14,7 @@ System requirements: - at least Java Runtime Environment (JRE) 11 - native libraries: libzkgroup, libsignal-client - Those are bundled for x86_64 Linux, for other systems/architectures see: [Provide native lib for libsignal](https://github.com/AsamK/signal-cli/wiki/Provide-native-lib-for-libsignal) + Those are bundled for x86_64 Linux (with recent enough glibc, see #643), for other systems/architectures see: [Provide native lib for libsignal](https://github.com/AsamK/signal-cli/wiki/Provide-native-lib-for-libsignal) ### Install system-wide on Linux See [latest version](https://github.com/AsamK/signal-cli/releases). @@ -67,11 +68,6 @@ The password and cryptographic keys are created when registering and stored in t $XDG_DATA_HOME/signal-cli/data/ $HOME/.local/share/signal-cli/data/ -For legacy users, the old config directories are used as a fallback: - - $HOME/.config/signal/data/ - $HOME/.config/textsecure/data/ - ## Building This project uses [Gradle](http://gradle.org) for building and maintaining