Bump version

[signal-cli] / README.md

diff --git a/README.md b/README.md
index a3900649a6b41da09e979eba0897b2dec08479de..178573fe32ced0fe3f6841036825352242912fc6 100644 (file)
--- 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.
 # 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.
 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, that can be used to send messages from any programming language that has dbus bindings.
+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
 
 
 ## Installation
 


@@ -12,7 +13,8 @@ You can [build signal-cli](#building) yourself, or use the [provided binary file
 System requirements:
 - at least Java Runtime Environment (JRE) 11
 - native libraries: libzkgroup, libsignal-client
 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).
 
 ### Install system-wide on Linux
 See [latest version](https://github.com/AsamK/signal-cli/releases).


@@ -35,8 +37,10 @@ Important: The USERNAME is your phone number in international format and must in
 * Register a number (with SMS verification)
 
         signal-cli -u USERNAME register
 * Register a number (with SMS verification)
 
         signal-cli -u USERNAME 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 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.
+
+  Registering may require solving a CAPTCHA challenge: [Registration with captcha](https://github.com/AsamK/signal-cli/wiki/Registration-with-captcha)

 
 * 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
 
 
 * 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
 


@@ -49,23 +53,20 @@ Important: The USERNAME is your phone number in international format and must in
 * Pipe the message content from another process.
 
         uname -a | signal-cli -u USERNAME send RECIPIENT
 * Pipe the message content from another process.
 
         uname -a | signal-cli -u USERNAME send RECIPIENT

-        
+

 * Receive messages
 
         signal-cli -u USERNAME receive
 
 * Receive messages
 
         signal-cli -u USERNAME 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 and other features.

 
 ## Storage
 
 The password and cryptographic keys are created when registering and stored in the current users home directory:
 
 
 ## Storage
 
 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/`)
-
-For legacy users, the old config directories are used as a fallback:
-
-        $HOME/.config/signal/data/
-
-        $HOME/.config/textsecure/data/
+        $XDG_DATA_HOME/signal-cli/data/
+        $HOME/.local/share/signal-cli/data/

 
 ## Building
 
 
 ## Building
 


@@ -98,11 +99,11 @@ This is still experimental and will not work in all situations.
 3. Execute Gradle:
 
         ./gradlew assembleNativeImage
 3. Execute Gradle:
 
         ./gradlew assembleNativeImage

-  
+

    The binary is available at *build/native-image/signal-cli*
 
    The binary is available at *build/native-image/signal-cli*
 

-## Troubleshooting
-If you use a version of the Oracle JRE and get an InvalidKeyException you need to enable unlimited strength crypto. See https://stackoverflow.com/questions/6481627/java-security-illegal-key-size-or-default-parameters for instructions.
+## FAQ and Troubleshooting
+For frequently asked questions and issues have a look at the [wiki](https://github.com/AsamK/signal-cli/wiki/FAQ)

 
 ## License
 
 
 ## License