X-Git-Url: https://git.nmode.ca/signal-cli/blobdiff_plain/1c4578ceac4b42152304d3292ffc0b09c15ac0d2..78518e0898d0132aed74ee0de366b08fd6b60482:/README.md

diff --git a/README.md b/README.md
index 552eac41..d95b2601 100644
--- a/README.md
+++ b/README.md
@@ -1,54 +1,75 @@
-# textsecure-cli
+# signal-cli
 
-textsecure-cli is a commandline interface for [libtextsecure-java](https://github.com/WhisperSystems/libtextsecure-java). It supports registering, verifying, sending and receiving messages. However receiving messages currently doesn't work, because libtextsecure-java [does not yet support registering for the websocket support](https://github.com/WhisperSystems/libtextsecure-java/pull/5). For registering you need a phone number where you can receive SMS or incoming calls.
-It is primarily intented to be used on servers to notify admins of important events.
+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).
+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.
 
-## Usage
+## 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.
 
-usage: textsecure-cli [-h] -u USERNAME {register,verify,send,receive} ...
+### 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/
+```
 
-* Register a number
+## Usage
 
-        textsecure-cli -u USERNAME register
+Important: The USERNAME (your phone number) must include the country calling code, i.e. the number must start with a "+" sign. (See [Wikipedia](https://en.wikipedia.org/wiki/List_of_country_calling_codes) for a list of all country codes.
 
-* Register a number with voice verification
+* Register a number (with SMS verification)
 
-        textsecure-cli -u USERNAME register -v
+        signal-cli -u USERNAME register
 
-* Verify the number using the code received via SMS
+* Verify the number using the code received via SMS or voice
 
-        textsecure-cli -u USERNAME verify CODE
+        signal-cli -u USERNAME verify CODE
 
-* Send a message to one or more recipients
+* Send a message
 
-        textsecure-cli -u USERNAME send -m "This is a message" [RECIPIENT [RECIPIENT ...]]
+        signal-cli -u USERNAME send -m "This is a message" RECIPIENT
 
 * Pipe the message content from another process.
 
-        uname -a | textsecure-cli -u USERNAME send [RECIPIENT [RECIPIENT ...]]
+        uname -a | signal-cli -u USERNAME send RECIPIENT
+        
+* Receive messages
+
+        signal-cli -u USERNAME receive
+
+For more information read the [man page](https://github.com/AsamK/signal-cli/blob/master/man/signal-cli.1.adoc) and the [wiki](https://github.com/AsamK/signal-cli/wiki).
 
 ## Storage
 
-The password and cryptographic keys are created when registering and stored in the current users home directory.
+The password and cryptographic keys are created when registering and stored in the current users home directory:
+
+        $HOME/.config/signal/data/
+
+For legacy users, the old config directory is used as a fallback:
 
         $HOME/.config/textsecure/data/
 
 ## Building
 
 This project uses [Gradle](http://gradle.org) for building and maintaining
-dependencies.
+dependencies. If you have a recent gradle version installed, you can replace `./gradlew` with `gradle` in the following steps.
 
-1. Checkout the source somewhere on your filesystem wit
+1. Checkout the source somewhere on your filesystem with
 
-        git clone https://github.com/AsamK/textsecure-cli.git
+        git clone https://github.com/AsamK/signal-cli.git
 
 2. Execute Gradle:
 
         ./gradlew build
 
-3. Create shell wrapper in *build/install/textsecure-cli/bin*:
+3. Create shell wrapper in *build/install/signal-cli/bin*:
 
-        ./gradlew installApp
+        ./gradlew installDist
 
 4. Create tar file in *build/distributions*:
 
@@ -59,8 +80,8 @@ If you use a version of the Oracle JRE and get an InvalidKeyException you need t
 
 ## License
 
-This project uses libtextsecure-java from Open Whisper Systems:
+This project uses libsignal-service-java from Open Whisper Systems:
 
-https://github.com/WhisperSystems/libtextsecure-java
+https://github.com/WhisperSystems/libsignal-service-java
 
 Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html