]> nmode's Git Repositories - signal-cli/blobdiff - README.md
Bump version
[signal-cli] / README.md
index dcfbad66cdb8308c2d5f292938ce39be4a8baf3d..50442c34bbb91a85a5567fcc807abb8513116a5b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,25 +6,24 @@ verifying, sending and receiving messages. To be able to link to an existing Sig
 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.
+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 daemon mode with D-BUS
+interface ([man page](https://github.com/AsamK/signal-cli/blob/master/man/signal-cli-dbus.5.adoc)) and JSON-RPC interface ([documentation](https://github.com/AsamK/signal-cli/wiki/JSON-RPC-service)). For the JSON-RPC interface there's also a simple [example client](https://github.com/AsamK/signal-cli/tree/master/client), written in Rust.
 
 ## Installation
 
-You can [build signal-cli](#building) yourself, or use
+You can [build signal-cli](#building) yourself or use
 the [provided binary files](https://github.com/AsamK/signal-cli/releases/latest), which should work on Linux, macOS and
-Windows. For Arch Linux there is also a [package in AUR](https://aur.archlinux.org/packages/signal-cli/) and there is
-a [FreeBSD port](https://www.freshports.org/net-im/signal-cli) available as well.
+Windows. There's also a [docker image and some Linux packages](https://github.com/AsamK/signal-cli/wiki/Binary-distributions) provided by the community.
 
 System requirements:
 
 - at least Java Runtime Environment (JRE) 17
 - native library: libsignal-client
 
-  The native lib is bundled for x86_64 Linux (with recent enough glibc, see #643), for other systems/architectures
+  The native libs are bundled for x86_64 Linux (with recent enough glibc), Windows and MacOS. 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
@@ -33,8 +32,8 @@ See [latest version](https://github.com/AsamK/signal-cli/releases).
 
 ```sh
 export VERSION=<latest version, format "x.y.z">
-wget https://github.com/AsamK/signal-cli/releases/download/v"${VERSION}"/signal-cli-"${VERSION}".tar.gz
-sudo tar xf signal-cli-"${VERSION}".tar.gz -C /opt
+wget https://github.com/AsamK/signal-cli/releases/download/v"${VERSION}"/signal-cli-"${VERSION}"-Linux.tar.gz
+sudo tar xf signal-cli-"${VERSION}"-Linux.tar.gz -C /opt
 sudo ln -sf /opt/signal-cli-"${VERSION}"/bin/signal-cli /usr/local/bin/
 ```
 
@@ -74,7 +73,7 @@ of all country codes.)
 
 * Pipe the message content from another process.
 
-        uname -a | signal-cli -a ACCOUNT send RECIPIENT
+        uname -a | signal-cli -a ACCOUNT send --message-from-stdin RECIPIENT
 
 * Receive messages