Add a README with overview and install requirements

This commit is contained in:
moneromooo 2014-12-22 13:32:56 +00:00
parent df5fe49c82
commit 936a25841b
1 changed files with 19 additions and 0 deletions

19
README Normal file
View File

@ -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.