From 464540de9a9d375aa548b5429b409022415a3977 Mon Sep 17 00:00:00 2001 From: mdivecky Date: Mon, 28 Sep 2020 18:45:10 +0200 Subject: [PATCH] readme formatting --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index f6537ed..f386ef0 100644 --- a/README.md +++ b/README.md @@ -5,30 +5,30 @@ It can be used as a gateway for automated notifications, bot with automatic repl ## Signald https://gitlab.com/thefinn93/signald -daemon that facilitates communication over Signal. -Using fixed pysignald https://gitlab.com/stavros/pysignald as python library. Latest version of pysignald is not compatible with changes in Signal protocol. +daemon that facilitates communication over Signal. +Using fixed pysignald https://gitlab.com/stavros/pysignald as python library. Latest version of pysignald is not compatible with changes in Signal protocol. Create directories `/signald, /signald/run, /signald/gradle` to avoid permissions issues with socket. You may still need to chown them if signald is not working ## registrations.json -Simple json file that receiver and sender scripts use as source of registered Signal accounts. At this time registrations need to be added manually to this file. +Simple json file that receiver and sender scripts use as source of registered Signal accounts. +At this time registrations need to be added manually to this file. ## Receiver -Creates threads for each registered number (in registrations.json) and listens for new messages. If there is new message, it writes it to RabbitMQ (queue signal-receive) for processing. +Creates threads for each registered number (in registrations.json) and listens for new messages. +If there is new message, it writes it to RabbitMQ (queue signal-receive) for processing. ## Sender Listens for new messages in RabbitMQ (queue signal-send) and sends them to signald. ## RabbitMQ -Stores received messages and messages that are supposed to be sent out. +Stores received messages and messages that are supposed to be sent out. Reason for using it is to accomodate communication between scripts and to be able to receive, send and process messages asynchronously. ## Worker -Processes recieved messages in RabbitMQ and sends new messages into it. -Doesn't care about the state of sending or receiving (for now). -More workers could be added for different tasks if needed. - -Right now, worker just takes received message and sends it back to the sender. - +Processes recieved messages in RabbitMQ and sends new messages into it. +Doesn't care about the state of sending or receiving (for now). +More workers could be added for different tasks if needed. +Right now, worker just takes received message and sends it back to the sender. In future, there should be API for receiving messages from other apps and respond to automatic messages.