diff --git a/README.md b/README.md index e69de29..eb7182f 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,40 @@ +# Trilium Bot + +Telegram-бот для быстрого создания заметок в [Trilium Notes](https://github.com/zadam/trilium). + +## Возможности + +- Отправьте текст боту — он создаст заметку в указанной папке Trilium +- Первая строка сообщения становится заголовком заметки +- Остальной текст — содержимым заметки + +## Требования + +- Python 3.11+ +- Trilium Notes с включённым ETAPI +- Telegram Bot Token + +## Переменные окружения + +| Переменная | Описание | +|------------------|-----------------------------------| +| `TELEGRAM_TOKEN` | Токен Telegram-бота | +| `TRILIUM_URL` | URL сервера Trilium (с ETAPI) | +| `TRILIUM_TOKEN` | ETAPI токен Trilium | +| `INBOX_NOTE_ID` | ID заметки-папки для входящих | + +## Запуск + +### Локально + +```bash +pip install -r requirements.txt +python main.py +``` + +### Docker + +```bash +docker build -t trilium-bot . +docker run --env-file .env trilium-bot +``` \ No newline at end of file