Fix removeReceiveHandler to not incorrectly reset the receiveThread

[signal-cli] / README.md

diff --git a/README.md b/README.md
index f8eee725ff5d726fb2b903b367a2396d194cc5a1..67bbb75ae955d25771e54d1c099fec73213e55ff 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,16 +1,17 @@
 # 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
 
 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.
 
 System requirements:
-- at least Java Runtime Environment (JRE) 11
+- at least Java Runtime Environment (JRE) 17
 - native libraries: libzkgroup, libsignal-client
 
   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)
@@ -80,14 +81,22 @@ dependencies. If you have a recent gradle version installed, you can replace `./
 
         ./gradlew build
 
-3. Create shell wrapper in *build/install/signal-cli/bin*:
+    2a. Create shell wrapper in *build/install/signal-cli/bin*:
 
         ./gradlew installDist
 
-4. Create tar file in *build/distributions*:
+    2b. Create tar file in *build/distributions*:
 
         ./gradlew distTar
 
+    2c. Create a fat tar file in *build/libs/signal-cli-fat*:
+
+        ./gradlew fatJar
+
+    2d. Compile and run signal-cli:
+
+        ./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).
@@ -97,9 +106,9 @@ This is still experimental and will not work in all situations.
 2. [Install prerequisites](https://www.graalvm.org/reference-manual/native-image/#prerequisites)
 3. Execute Gradle:
 
-        ./gradlew assembleNativeImage
+        ./gradlew nativeCompile
 
-   The binary is available at *build/native-image/signal-cli*
+   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)