chore: add README.md (#3)

* chore: README.md * Apply suggestions from code review Co-authored-by: michael1011 <[email protected]> --------- Co-authored-by: michael1011 <[email protected]>
BoltzExchange · Jan 19, 2025 · 5665847 · 5665847
1 parent 57dcd27
commit 5665847
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/.env.sample b/.env.sample
@@ -0,0 +1,3 @@
+TELEGRAM_BOT_TOKEN=<your-telegram-bot-token>
+FEE_THRESHOLD=0
+DATABASE_URL=postgresql+asyncpg://boltz:boltz@localhost:5433/fees
diff --git 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`.