From 936a25841bc4b2c37440504af164b10a8aa01c59 Mon Sep 17 00:00:00 2001 From: moneromooo Date: Mon, 22 Dec 2014 13:32:56 +0000 Subject: [PATCH] Add a README with overview and install requirements --- README | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..6afcaf5 --- /dev/null +++ b/README @@ -0,0 +1,19 @@ +This is a monero IRC tipbot. + +Installation requirements: + - monero + - python + - redis + - python-redis + +The daemon needs a running redis, bitmonerod and simplewallet. Set the connection parameters +for these in tipbot.py. + +Tipbot commands are prefix with "!". Try !help to get a list of available commands. + +The withdrawal fee is currently set to the default network fee. If a withdraw transaction +happens to be larger than 1 kB, more will be charged by simplewallet. The withdrawal fee +can be set higher to guard against this. + +If a withdrawal error happens, withdrawals are disabled until enabled again by the operator, +to avoid possible exploits.