From 56658474a166dba4b65f5777d446ab1479684476 Mon Sep 17 00:00:00 2001 From: jackstar12 <62219658+jackstar12@users.noreply.github.com> Date: Sun, 19 Jan 2025 18:55:39 +0100 Subject: [PATCH] chore: add README.md (#3) * chore: README.md * Apply suggestions from code review Co-authored-by: michael1011 --------- Co-authored-by: michael1011 --- .env.sample | 3 +++ README.md | 13 +++++++++++++ 2 files changed, 16 insertions(+) create mode 100644 .env.sample diff --git a/.env.sample b/.env.sample new file mode 100644 index 0000000..e06d4e6 --- /dev/null +++ b/.env.sample @@ -0,0 +1,3 @@ +TELEGRAM_BOT_TOKEN= +FEE_THRESHOLD=0 +DATABASE_URL=postgresql+asyncpg://boltz:boltz@localhost:5433/fees diff --git a/README.md b/README.md index e69de29..919cba3 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,13 @@ +# Boltz Fee Bot + +A Telegram bot that allows users to subscribe to fee changes on [Boltz Pro](https://pro.boltz.exchange) + +## Setup + +The bot uses [uv](https://docs.astral.sh/uv/) for dependency management. + +For running the bot, you need to have a telegram bot token. You can get one by talking to [BotFather](https://core.telegram.org/bots#botfather) + +A PostgreSQL database is required for storing subscribed chats. Run `make postgres` to get a local instance running. + +Once setup, copy the `.env.sample` file to `.env` and fill in the values. Start the bot with `uv run bot.py` or use the `Dockerfile`.