X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/76f27449dfea58bcd9a8bafd2f8d3c167e355a7c..b998f322f58fb20c6e545918ee5ec9af80d3aae5:/README.md

diff --git a/README.md b/README.md
index 3632d08d..e6d6e5ff 100644
--- a/README.md
+++ b/README.md
@@ -1,31 +1,33 @@
 # 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 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.
+signal-cli is a commandline interface for the [Signal messenger](https://signal.org/).
+It supports registering, verifying, sending and receiving messages.
+signal-cli uses a [patched libsignal-service-java](https://github.com/Turasa/libsignal-service-java),
+extracted from the [Signal-Android source code](https://github.com/signalapp/Signal-Android/tree/main/libsignal-service).
+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 daemon mode with JSON-RPC interface ([man page](https://github.com/AsamK/signal-cli/blob/master/man/signal-cli-jsonrpc.5.adoc))
+and D-BUS interface ([man page](https://github.com/AsamK/signal-cli/blob/master/man/signal-cli-dbus.5.adoc)) .
+For the JSON-RPC interface there's also a simple [example client](https://github.com/AsamK/signal-cli/tree/master/client), written in Rust.
+
+signal-cli needs to be kept up-to-date to keep up with Signal-Server changes.
+The official Signal clients expire after three months and then the Signal-Server can make incompatible changes.
+So signal-cli releases older than three months may not work correctly.
 
 ## 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/), as well as
-a [FreeBSD port](https://www.freshports.org/net-im/signal-cli) and
-an [Alpine aport](https://pkgs.alpinelinux.org/packages?name=signal-cli).
+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
+- at least Java Runtime Environment (JRE) 21
 - native library: libsignal-client
 
-  The native libs are bundled for x86_64 Linux (with recent enough glibc, see #643), Windows and MacOS. 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
@@ -34,15 +36,14 @@ 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}"-Linux.tar.gz
-sudo tar xf signal-cli-"${VERSION}"-Linux.tar.gz -C /opt
+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
 sudo ln -sf /opt/signal-cli-"${VERSION}"/bin/signal-cli /usr/local/bin/
 ```
 
 You can find further instructions on the Wiki:
 
 - [Quickstart](https://github.com/AsamK/signal-cli/wiki/Quickstart)
-- [DBus Service](https://github.com/AsamK/signal-cli/wiki/DBus-service)
 
 ## Usage
 
@@ -56,10 +57,17 @@ of all country codes.)
 
 * Register a number (with SMS verification)
 
-        signal-cli -a ACCOUNT register
+      signal-cli -a ACCOUNT register
 
-  You can register Signal using a land line number. In this case you can skip SMS verification process and jump directly
-  to the voice call verification by adding the `--voice` switch at the end of above register command.
+  You can register Signal using a landline number. In this case, you need to follow the procedure below:
+   * Attempt a SMS verification process first (`signal-cli -a ACCOUNT register`)
+     * You will get an error `400 (InvalidTransportModeException)`, this is normal
+   * Wait 60 seconds
+   * Attempt a voice call verification by adding the `--voice` switch and wait for the call:
+
+     ```sh
+     signal-cli -a ACCOUNT register --voice
+     ```
 
   Registering may require solving a CAPTCHA
   challenge: [Registration with captcha](https://github.com/AsamK/signal-cli/wiki/Registration-with-captcha)
@@ -67,19 +75,21 @@ of all country codes.)
 * Verify the number using the code received via SMS or voice, optionally add `--pin PIN_CODE` if you've added a pin code
   to your account
 
-        signal-cli -a ACCOUNT verify CODE
+      signal-cli -a ACCOUNT verify CODE
 
 * Send a message
 
-        signal-cli -a ACCOUNT send -m "This is a message" RECIPIENT
+     ```sh
+     signal-cli -a ACCOUNT send -m "This is a message" RECIPIENT
+     ```
 
 * 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
 
-        signal-cli -a ACCOUNT receive
+      signal-cli -a ACCOUNT receive
 
 **Hint**: The Signal protocol expects that incoming messages are regularly received (using `daemon` or `receive`
 command). This is required for the encryption to work efficiently and for getting updates to groups, expiration timer
@@ -89,8 +99,8 @@ and other features.
 
 The password and cryptographic keys are created when registering and stored in the current users home directory:
 
-        $XDG_DATA_HOME/signal-cli/data/
-        $HOME/.local/share/signal-cli/data/
+    $XDG_DATA_HOME/signal-cli/data/
+    $HOME/.local/share/signal-cli/data/
 
 ## Building
 
@@ -99,44 +109,45 @@ version installed, you can replace `./gradlew` with `gradle` in the following st
 
 1. Checkout the source somewhere on your filesystem with
 
-        git clone https://github.com/AsamK/signal-cli.git
+       git clone https://github.com/AsamK/signal-cli.git
 
 2. Execute Gradle:
 
-        ./gradlew build
+       ./gradlew build
 
    2a. Create shell wrapper in *build/install/signal-cli/bin*:
 
-        ./gradlew installDist
+       ./gradlew installDist
 
    2b. Create tar file in *build/distributions*:
 
-        ./gradlew distTar
+       ./gradlew distTar
 
    2c. Create a fat tar file in *build/libs/signal-cli-fat*:
 
-        ./gradlew fatJar
+       ./gradlew fatJar
 
    2d. Compile and run signal-cli:
 
-        ./gradlew run --args="--help"
+      ```sh
+      ./gradlew run --args="--help"
+      ```
 
 ### Building a native binary with GraalVM (EXPERIMENTAL)
 
 It is possible to build a native binary with [GraalVM](https://www.graalvm.org). This is still experimental and will not
 work in all situations.
 
-1. [Install GraalVM and setup the enviroment](https://www.graalvm.org/docs/getting-started/#install-graalvm)
-2. [Install prerequisites](https://www.graalvm.org/reference-manual/native-image/#prerequisites)
-3. Execute Gradle:
+1. [Install GraalVM and setup the environment](https://www.graalvm.org/docs/getting-started/#install-graalvm)
+2. Execute Gradle:
 
-        ./gradlew nativeCompile
+       ./gradlew nativeCompile
 
    The binary is available at *build/native/nativeCompile/signal-cli*
 
 ## FAQ and Troubleshooting
 
-For frequently asked questions and issues have a look at the [wiki](https://github.com/AsamK/signal-cli/wiki/FAQ)
+For frequently asked questions and issues have a look at the [wiki](https://github.com/AsamK/signal-cli/wiki/FAQ).
 
 ## License