From 5c29236bc69bd527d043cfc95e4872f76c01982a Mon Sep 17 00:00:00 2001 From: Finn Date: Tue, 2 Feb 2021 17:58:12 -0800 Subject: [PATCH] Update README --- cmd/signaldctl/README.md | 32 ++++++++++---------------------- 1 file changed, 10 insertions(+), 22 deletions(-) diff --git a/cmd/signaldctl/README.md b/cmd/signaldctl/README.md index 1dce4a2..990e364 100644 --- a/cmd/signaldctl/README.md +++ b/cmd/signaldctl/README.md @@ -1,36 +1,24 @@ # signaldctl *a command line tool for [signald](https://gitlab.com/signald/signald)* -signaldctl is new and not well supported at this time. If you experience bugs, please report them. +# Install - - -## Account Creation: Linking - -To link signald to an existing Signal account (by scanning a QR code): +If you have the [signald debian repo](https://gitlab.com/signald/signald/-/blob/main/docs/install/debian.md) installed: ``` -signaldctl account create --link +sudo apt install signaldctl ``` -## Account Creation: Registration +otherwise, download a binary from the CI: +* [x86_64](https://gitlab.com/api/v4/projects/21018340/jobs/artifacts/main/raw/signaldctl?job=build%3Ax86) +* [aarch64](https://gitlab.com/api/v4/projects/21018340/jobs/artifacts/main/raw/signaldctl?job=build%3Aaarch64) -To register a new account: +or build it yourself: ``` -signaldctl account create --request-code --phone-number +15555555555 +go get gitlab.com/signald/signald-go/cmd/signaldctl ``` -you will receive an SMS verification code. Submit the code to create the account: +# Use -``` -signaldctl account create --verify --phone-number +15555555555 --code 999-999 -``` - -## Sending messages - -``` -signaldctl message send --account +15555555555 --to +12024561414 --message "yo" -``` - -`--to` can also be a group ID \ No newline at end of file +[see in progress documentation site](https://signald.gitlab.io/signald-go/signaldctl/) \ No newline at end of file