Implement daemon mode with dbus interface

[signal-cli] / README.md

diff --git a/README.md b/README.md
index 897b9fd165631138c723877877e0c3e037e5503d..8790fc8d0835c12e6a116cd787aa8873bb9de484 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,31 +1,49 @@
 # textsecure-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.
-It is primarily intented to be used on servers to notify admins of important events.
+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 only works with a patched libtextsecure-java, 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 intended to be used on servers to notify admins of important events.
 
 ## Usage
 
-usage: textsecure-cli [-h] -u USERNAME {register,verify,send,receive} ...
+usage: textsecure-cli [-h] [-u USERNAME] [-v] {register,verify,send,quitGroup,updateGroup,receive} ...
 
-* Register a number
+* Register a number (with SMS verification)
 
         textsecure-cli -u USERNAME register
 
-* Verify the number using the code received via SMS
+* Register a number (with voice verification)
+
+        textsecure-cli -u USERNAME register -v
+
+* Verify the number using the code received via SMS or voice
 
         textsecure-cli -u USERNAME verify CODE
 
 * Send a message to one or more recipients
 
-        textsecure-cli -u USERNAME send -m "This is a message" [RECIPIENT [RECIPIENT ...]]
+        textsecure-cli -u USERNAME send -m "This is a message" [RECIPIENT [RECIPIENT ...]] [-a [ATTACHMENT [ATTACHMENT ...]]]
 
 * Pipe the message content from another process.
 
         uname -a | textsecure-cli -u USERNAME send [RECIPIENT [RECIPIENT ...]]
 
+* Groups
+
+ * Create a group
+
+          textsecure-cli -u USERNAME updateGroup -n "Group name" -m [MEMBER [MEMBER ...]]
+
+ * Update a group
+
+          textsecure-cli -u USERNAME updateGroup -g GROUP_ID -n "New group name"
+
+ * Send a message to a group
+
+          textsecure-cli -u USERNAME send -m "This is a message" -g GROUP_ID
+
 ## 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/textsecure/data/
 
@@ -34,7 +52,7 @@ The password and cryptographic keys are created when registering and stored in t
 This project uses [Gradle](http://gradle.org) for building and maintaining
 dependencies.
 
-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
 
@@ -44,12 +62,15 @@ dependencies.
 
 3. Create shell wrapper in *build/install/textsecure-cli/bin*:
 
-        ./gradlew installApp
+        ./gradlew installDist
 
 4. Create tar file in *build/distributions*:
 
         ./gradlew distTar
 
+## 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.
+
 ## License
 
 This project uses libtextsecure-java from Open Whisper Systems: