diff options
| author | Florian Fischer <florian.fl.fischer@fau.de> | 2017-08-11 18:07:51 +0200 |
|---|---|---|
| committer | Florian Fischer <florian.fl.fischer@fau.de> | 2017-08-11 18:07:51 +0200 |
| commit | 2742ba91678963cef2f8f82d4142d4c6d5ab8958 (patch) | |
| tree | 1ac5859f87e33bbd1eef7267fa79552b90279df4 | |
| download | geldschieberbot-2742ba91678963cef2f8f82d4142d4c6d5ab8958.tar.gz geldschieberbot-2742ba91678963cef2f8f82d4142d4c6d5ab8958.zip | |
add Readme
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | Readme.md | 21 |
2 files changed, 22 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7e99e36 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +*.pyc
\ No newline at end of file diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..7560347 --- /dev/null +++ b/Readme.md @@ -0,0 +1,21 @@ +# Geldschieberbot + +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 + +Geldschieberbot is configured with a set of Environment variables: + +* GSB_GROUP_ID the signal group_id you want to serve +* GSB_STORE_PATH the directory where Geldschieberbot stores the balance and the useres +* GSB_SEND_CMD the command Geldschieberbot uses to send replies + +Geldschieberbot must be fed with signal messages recieved by signal-cli. +Just pipe the output of signal-cli receive through Geldschieberbot in a cron +job and you are good to go. + + +Happy Geldschieben! + |