diff --git a/README.md b/README.md new file mode 100644 index 0000000..4a97fcd --- /dev/null +++ b/README.md @@ -0,0 +1,89 @@ +# node-tip-bot +node-tip-bot is an open-source node.js IRC bot for tipping with altcoins. It uses [node-dogecoin](https://github.com/countable/node-dogecoin) for integration with Litecoin's JSON RPC API. + +## Instalation +To install node-tip-bot simply clone this repo and install dependencies: +```bash +git clone https://github.com/unek/node-tip-bot +cd node-tip-bot +npm install +``` +After installation proceed to the configuration. + +## Configuration +To configure, edit the config/config.yml file. +### connection +IRC network connection info. +* **host** - hostname of the IRC server +* **port** - port of the IRC server +* **secure** - use secured connection +* **status_command** - NickServ command to get nick's login status, ACC on freenode, STATUS on some other networks +### login +IRC network connection and login info. +* **nickname** - bot's nickname +* **username** - bot's username +* **realname** - bot's realname +* **nickserv_password** - nickserv password to identify with +### channels +List of channels to auto-join to. +### log +Logging settings. +* **file** - file to log to. Set to `false` to disable logging to file. +### rpc +JSON RPC API connection info. +* **host** - JSON RPC API hostname +* **port** - API port (by default 22555 for dogecoin) +* **user** - API username +* **pass** - API password (keep that secure) +### coin +Basic coin settings. +* **withdrawal_fee** - fee collected on withdraw to cover up txfee, the rest goes to bot's wallet. +* **min_withdraw** - minimum amount of coins to withdraw +* **min_confirmations** - minimum amount of confirmations needed to tip/withdraw coins +* **min_tip** - minimum amount of coins to tip +* **short_name** - short coin's name (eg. `Đ` or `DOGE`) +* **full_name** - full coin's name (eg. `dogecoin`) +### commands +Here you can restrict some commands to work only on PM/channel. +### messages +Whatever the bot says. Supports expandable variables (eg. `%nick%` for bot's nick). By default all config vars from `rpc` section are available. + + +## Commands + +| **Command** | **Arguments** | **Description** +|-------------|-------------------|-------------------------------------------------------------------- +| `balance` | | displays your current wallet balance +| `address` | | displays address where you can send your funds to the tip bot +| `withdraw` | `
` | withdraws your whole wallet balance to specified address +| `tip` | `