diff --git a/README.md b/README.md index 72b25c0..6f2322a 100644 --- a/README.md +++ b/README.md @@ -35,30 +35,62 @@ For sell orders with static stoploss ./crypto -pair=BTC/USDT -price=9400 -amount=0.1 ``` -Use telegram for notifications. + +## Notifications + +- Telegram. ```sh ./crypto -pair=BTC/USDT -percent=3 -interval=60 -telegram.chat= ``` -> For get user id, talk o the [userinfobot](https://t.me/userinfobot) - ![Crypto bot Telegram](https://raw.githubusercontent.com/giansalex/crypto-com-trailing-stop-loss/master/doc/crypto-com-telegram-bot.png) +> For get user id, talk to the [userinfobot](https://t.me/userinfobot) + + +- Mailing. +```sh +./crypto -pair=BTC/USDT -percent=3 \ + -mail.host="smtp.example.com" \ + -mail.port=587 \ + -mail.user="user@example.com" \ + -mail.pass="xxxx" \ + -mail.from="user@example.com" \ + -mail.to="bob@gmail.com" +``` + +> You can notify both: telegram, mail. + + List available parameters ```sh - -type string - order type: SELL or BUY (default: SELL) - -pair string - market pair, example: MCO/USDT + -amount float + (optional) amount to order (sell or buy) on stoploss -interval int interval in seconds to update price, example: 30 (30 sec.) (default 30) - -price float - price (for static stoploss) + -mail.from string + (optional) email sender + -mail.host string + (optional) SMTP Host + -mail.pass string + (optional) SMTP Password + -mail.port int + (optional) SMTP Port (default 587) + -mail.to string + (optional) email receptor + -mail.user string + (optional) SMTP User + -pair string + market pair, example: MCO/USDT -percent float - percent (for trailing stoploss), example: 3.0 (3%) - -amount float - (optional) amount to order (sell or buy) on stoploss, default all balance + percent (for trailing stop loss), example: 3.0 (3%) + -price float + price (for static stop loss), example: 9200.00 (BTC price) + -stop-change + Notify on stoploss change (default: false) -telegram.chat int (optional) telegram User ID for notify + -type string + order type: SELL or BUY (default "SELL") ``` ## Signup