Split load function

[signal-cli] / README.md

diff --git a/README.md b/README.md
index 256445bf41eafcf7760cac1cc27b0fe76ef8743d..617742c2a4b003a675e39e04ea7bbe2adb9991e9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,11 +1,24 @@
 # signal-cli
 
 # 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 receiving messages signal-cli uses a [patched libsignal-service-java](https://github.com/AsamK/libsignal-service-java), because libsignal-service-java [does not yet support registering for the websocket support](https://github.com/WhisperSystems/libsignal-service-java/pull/5) nor [provisioning as a slave 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 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 receive messages signal-cli uses a [patched libsignal-service-java](https://github.com/AsamK/libsignal-service-java), because libsignal-service-java [does not yet support registering for the websocket support](https://github.com/WhisperSystems/libsignal-service-java/pull/5) nor [provisioning as a slave 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.

 It 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.
 
 It 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.
 

+## 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/). You need to have at least JRE 7 installed, to run signal-cli.
+
+### Install system-wide on Linux
+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
+sudo ln -sf /opt/signal-cli-"${VERSION}"/bin/signal-cli /usr/local/bin/
+```
+

 ## Usage
 
 ## Usage
 

-usage: signal-cli [-h] [-v] [--config CONFIG] [-u USERNAME | --dbus | --dbus-system] {link,addDevice,listDevices,removeDevice,register,verify,send,quitGroup,updateGroup,receive,daemon} ...
+usage: signal-cli [-h] [-v] [--config CONFIG] [-u USERNAME | --dbus | --dbus-system] {link,addDevice,listDevices,removeDevice,register,verify,send,quitGroup,updateGroup,listIdentities,trust,receive,daemon} ...

 
 * Register a number (with SMS verification)
 
 
 * Register a number (with SMS verification)
 


@@ -74,6 +87,24 @@ usage: signal-cli [-h] [-v] [--config CONFIG] [-u USERNAME | --dbus | --dbus-sys
 
           signal-cli -u USERNAME removeDevice -d DEVICE_ID
 
 
           signal-cli -u USERNAME removeDevice -d DEVICE_ID
 

+* Manage trusted keys
+
+ * View all known keys
+
+          signal-cli -u USERNAME listIdentities
+
+ * View known keys of one number
+
+          signal-cli -u USERNAME listIdentities -n NUMBER
+
+ * Trust new key, after having verified it
+
+          signal-cli -u USERNAME trust -v FINGER_PRINT NUMBER
+
+ * Trust new key, without having verified it. Only use this if you don't care about security
+
+          signal-cli -u USERNAME trust -a NUMBER
+

 ## DBus service
 
 signal-cli can run in daemon mode and provides an experimental dbus interface.
 ## DBus service
 
 signal-cli can run in daemon mode and provides an experimental dbus interface.