From: AsamK <asamk@gmx.de>
Date: Sun, 3 Jul 2016 10:43:30 +0000 (+0200)
Subject: Update README.md
X-Git-Tag: v0.4.1~7
X-Git-Url: https://git.nmode.ca/signal-cli/commitdiff_plain/bc17f9317e09c97907123da06a44b42b67f16b0d

Update README.md

Add Installation section

Closes #18
---

diff --git a/README.md b/README.md
index 256445bf..cc9bde5f 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,18 @@
 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.
 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, 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
+```sh
+export VERSION=<latest version, e.g. "0.4.0">
+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: signal-cli [-h] [-v] [--config CONFIG] [-u USERNAME | --dbus | --dbus-system] {link,addDevice,listDevices,removeDevice,register,verify,send,quitGroup,updateGroup,receive,daemon} ...