From: AsamK Date: Fri, 2 Apr 2021 07:22:15 +0000 (+0200) Subject: Update README X-Git-Tag: v0.8.2~60 X-Git-Url: https://git.nmode.ca/signal-cli/commitdiff_plain/4f9c0172ef42b03e34d7756b96cbb6f522c68adf?hp=caf16231aaf7550cedf74c66f5ddfa9a82b7bb88 Update README --- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0bc3167a..c0afee3f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,3 +6,7 @@ If you have a question you can ask it in the [GitHub discussions page](https://g - If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/AsamK/signal-cli/issues/new). - Be sure to include a **title and clear description**, as much relevant information as possible. - Run the failing command with `--verbose` flag to get a more detailed log output and include that in the bug report + +# Pull request +- Code style should match the existing code, IntelliJ users can use the auto formatter +- Separate PRs should be opened for each implemented feature or bug fix diff --git a/README.md b/README.md index 90a666e8..5eb9e78d 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ 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. +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. ## Installation