diff --git a/README.md b/README.md index 344d8fa5..de080377 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,17 @@
-
- + # @LightningTipBot 🏅 -A tip bot for Telegram group chats that can send and receive Bitcoin via the Lightning Network ⚡️. It can also be used as a personal Lightning wallet by anyone who has a Telegram account. +A tip bot and Lightning ⚡️ Bitcoin Wallet for Telegram group chats. It can also be used as a personal Lightning wallet by anyone who has a Telegram account. -This repository contains everything you need to set up and run your own tip bot. If you simply want to use this bot in your group chat without having to install anything just start a conversation with [@LightningTipBot](https://t.me/LightningTipBot) and invite it into your chat. +This repository contains everything you need to set up and run your own tip bot. If you simply want to use this bot in your group chat without having to install anything just start a conversation with [@LightningTipBot](https://t.me/LightningTipBot) and invite it into your chat. ## Setting up the bot + ### Installation + To build the bot from source, clone the repository and compile the source code. ``` @@ -20,7 +21,7 @@ go build . cp config.yaml-example config.yaml ``` -Alternatively, you can download binary releases [here](https://github.com/LightningTipBot/LightningTipBot/releases) **(note: no realses yet)**. +Alternatively, you can download binary releases [here](https://github.com/LightningTipBot/LightningTipBot/releases) **(note: no realses yet)**. After you have configured the bot, start it using the command @@ -34,9 +35,9 @@ You need to edit `config.yaml` before starting the bot. #### Create a Telegram bot -First, create a new Telegram bot by starting a conversation with the [@BotFather](https://core.telegram.org/bots#6-botfather). After you have created your bot, you will get an **Api Token** which you need to add to `telegram_api_key` in config.yaml accordingly. +First, create a new Telegram bot by starting a conversation with the [@BotFather](https://core.telegram.org/bots#6-botfather). After you have created your bot, you will get an **Api Token** which you need to add to `telegram_api_key` in config.yaml accordingly. -#### Set up LNbits +#### Set up LNbits You can either use your own LNbits instance (recommended) or create an account at [lnbits.com](https://lnbits.com/) to use their custodial service (easy). @@ -49,17 +50,19 @@ You can either use your own LNbits instance (recommended) or create an account a-
+ #### More configuration -* `webhook_server`: URL that can reach the bot. This is used for creating webhooks with LNbits to receive notifications about payments (optional). -* `db_path`: User database file path. -* `transactions_path`: Transaction log file path. -* `message_dispose_duration`: Duration in seconds after which commands will be deleted from channel (only if the bot is channel admin). + +- `webhook_server`: URL that can reach the bot. This is used for creating webhooks with LNbits to receive notifications about payments (optional). +- `db_path`: User database file path. +- `transactions_path`: Transaction log file path. +- `message_dispose_duration`: Duration in seconds after which commands will be deleted from channel (only if the bot is channel admin). ## Features ### Commands + ``` /tip 🏅 Reply to a message to tip it: /tip-
+ ### Auto-delete commands -To minimize the clutter all the heavy tipping can cause in a group chat, the bot will remove all failed commands (for example due to a syntax error) from the chat immediately. All successful commands will stay visible for `message_dispose_duration` seconds (default 10s) and then be removed. The tips will sill be visible for everyone in the Live tooltip. This feature only works, if the bot is made admin of the group. +To minimize the clutter all the heavy tipping can cause in a group chat, the bot will remove all failed commands (for example due to a syntax error) from the chat immediately. All successful commands will stay visible for `message_dispose_duration` seconds (default 10s) and then be removed. The tips will sill be visible for everyone in the Live tooltip. This feature only works, if the bot is made admin of the group. ## Made with -* [LNbits](https://github.com/lnbits/lnbits) – Free and open-source lightning-network wallet/accounts system. -* [telebot](https://github.com/tucnak/telebot) – A Telegram bot framework in Go. -* [gozxing](https://github.com/makiuchi-d/gozxing) – barcode image processing library in Go. -* [ln-decodepay](https://github.com/fiatjaf/ln-decodepay) – Lightning Network BOLT11 invoice decoder. +- [LNbits](https://github.com/lnbits/lnbits) – Free and open-source lightning-network wallet/accounts system. +- [telebot](https://github.com/tucnak/telebot) – A Telegram bot framework in Go. +- [gozxing](https://github.com/makiuchi-d/gozxing) – barcode image processing library in Go. +- [ln-decodepay](https://github.com/fiatjaf/ln-decodepay) – Lightning Network BOLT11 invoice decoder.