aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFlorian Fischer <florian.fl.fischer@fau.de>2017-08-20 18:22:02 +0200
committerFlorian Fischer <florian.fl.fischer@fau.de>2017-08-20 18:22:02 +0200
commitfeeda362b68d48d6057ae8b992537692c5d787d0 (patch)
tree2d47059810036d54b78f76e713150a3cf367e840
parent81553c1042de3fc2970d1afa5f1605ed7f54b495 (diff)
downloadgeldschieberbot-feeda362b68d48d6057ae8b992537692c5d787d0.tar.gz
geldschieberbot-feeda362b68d48d6057ae8b992537692c5d787d0.zip
mention config.sh in Readme
-rw-r--r--Readme.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/Readme.md b/Readme.md
index 16c360d..e23b543 100644
--- a/Readme.md
+++ b/Readme.md
@@ -4,7 +4,9 @@ Geldschieberbot is a python script to bookkeep the finances of a group.
It is intended to be run on the output of signal-cli. But it should parse
other input without a lot of modification.
-## Usage
+## Configuration
+
+You can edit config.sh to match your needs or set the Environment your self.
Geldschieberbot is configured with a set of Environment variables:
@@ -13,8 +15,11 @@ Geldschieberbot is configured with a set of Environment variables:
* GSB_SEND_CMD the command Geldschieberbot uses to send replies
* GSB_USER the mobile number signal-cli should receive messages with
-Geldschieberbot must be fed with signal messages recieved by signal-cli.
-Just execute run.sh in tmux and you should be fine.
+## Usage
+
+If you edited config.sh you can just run
+`config.sh && run.sh`
+and your bot should be up and serving your needs.
Happy Geldschieben!