Update README.md

README.md

@@ -1,6 +1,6 @@
 ---
-title: TgAPIToolsTunnel
-emoji: 🛠️
+title: Telegram Bot API Proxy & Tools
+emoji: 🚀
 colorFrom: green
 colorTo: blue
 sdk: docker
@@ -16,9 +16,9 @@ pinned: false
 ---
 <a id="ru"></a>
 
-## 🇷🇺 TgAPIToolsTunnel: Прокси Telegram Bot API с расширенными инструментами
+## 🇷🇺 Прокси Telegram Bot API с расширенными инструментами
 
-Этот Space запускает локальный сервер Telegram Bot API и предоставляет многофункциональное Node.js приложение-прокси с дополнительными инструментами.
+Этот Space запускает локальный сервер Telegram Bot API и предоставляет многофункциональное Node.js приложение-прокси с дополнительными инструментами. Посетите корневой URL вашего Space для интерактивной документации.
 
 ### 1. Основные возможности
 
@@ -56,96 +56,32 @@ pinned: false
 
 ### 3. Использование API
 
-**Базовый URL вашего Space**: `https://[YOUR_SPACE_URL]`
+**Посетите корневой URL вашего Space (`https://[YOUR_SPACE_URL]/`) для интерактивной документации по API.**
+
+Краткое описание:
 
 #### 3.1. Прокси Telegram Bot API
 
 *   **URL**: `https://[YOUR_SPACE_URL]/tg/bot<YOUR_BOT_TOKEN>/<METHOD_NAME>`
-*   **Описание**: Используйте этот URL вместо стандартного `api.telegram.org`.
-*   **Расширенные ответы**: Если метод API возвращает объект файла (например, в `result.photo` для `getMe`, или `result` для `getFile`), ответ будет автоматически дополнен следующими полями:
-    *   `direct_download_link_by_path`: Прямая ссылка на скачивание файла по его относительному пути.
-    *   `direct_download_link_by_id`: Прямая ссылка на скачивание файла по его ID.
-    *   `delete_link_by_path`: Ссылка для удаления файла по его относительному пути.
-    *   `delete_link_by_id`: Ссылка для удаления файла по его ID.
-    *   `encrypted_download_link_by_path` (если `LINK_ENCRYPTION_KEY` установлен): Зашифрованная ссылка на скачивание по пути с ограниченным сроком действия.
-    *   `encrypted_download_link_by_id` (если `LINK_ENCRYPTION_KEY` установлен): Зашифрованная ссылка на скачивание по ID с ограниченным сроком действия.
-*   **Управление сроком действия ссылок**:
-    *   Срок действия по умолчанию задается переменной `DEFAULT_LINK_EXPIRY_HOURS`.
-    *   Можно переопределить для конкретного запроса, добавив параметр `?link_expiry_hours=N` к URL проксируемого запроса (например, `.../getMe?link_expiry_hours=2`). `N=-1` для бессрочной ссылки.
+*   **Описание**: Используйте этот URL вместо стандартного `api.telegram.org`. Ответы API, содержащие информацию о файлах, будут автоматически дополнены полезными ссылками (прямые, зашифрованные, на удаление).
+*   **Управление сроком действия ссылок**: Добавьте параметр `?link_expiry_hours=N` к URL проксируемого запроса.
 
 #### 3.2. Инструменты управления
 
-##### 3.2.1. Общая информация
-
-*   **URL**: `https://[YOUR_SPACE_URL]/`
-*   **Метод**: `GET`
-*   **Ответ**: JSON с описанием доступных эндпоинтов и конфигурации.
-
-##### 3.2.2. Статистика
-
-*   **URL**: `https://[YOUR_SPACE_URL]/stats`
-*   **Метод**: `GET`
-*   **Параметры Query**:
-    *   `run_ttl_now=true` (опционально): Запустить очистку старых файлов немедленно.
-*   **Ответ**: JSON со статистикой по файлам в `TELEGRAM_DATA_DIR`.
-
-##### 3.2.3. Операции с файлами (базовый путь: `/file`)
-
-1.  **Список файлов для бота**
-    *   **URL**: `/list?token=<BOT_TOKEN>`
-    *   **Метод**: `GET`
-    *   **Ответ**: JSON со списком файлов, их размерами и общим размером для указанного бота.
-
-2.  **Получение информации о файле (расширенное)**
-    *   **URL**: `/<BOT_TOKEN>/getFile?file_id=<FILE_ID>`
-    *   **Метод**: `GET`
-    *   **Параметры Query**:
-        *   `link_expiry_hours=N` (опционально): Установить срок жизни для генерируемых зашифрованных ссылок (в часах, `-1` для бессрочных).
-    *   **Ответ**: Стандартный ответ `getFile` от Telegram API, дополненный ссылками, как описано в разделе 3.1.
-
-3.  **Скачивание файла по ID**
-    *   **URL**: `/<BOT_TOKEN>/downloadFile?file_id=<FILE_ID>`
-    *   **Метод**: `GET`
-    *   **Ответ**: Файл для скачивания.
-
-4.  **Скачивание файла по пути**
-    *   **URL**: `/<ОТНОСИТЕЛЬНЫЙ_ПУТЬ_К_ФАЙЛУ_ВНУТРИ_TELEGRAM_DATA_DIR>`
-        *   Пример: `/bot123:abc/photos/file_0.jpg`
-    *   **Метод**: `GET`
-    *   **Ответ**: Файл для скачивания.
-
-5.  **Скачивание по зашифрованной ссылке**
-    *   **URL**: `/downloadEncrypted?payload=<ENCRYPTED_PAYLOAD>`
-    *   **Метод**: `GET`
-    *   **Ответ**: Файл для скачивания, если ссылка действительна и не истекла.
-
-6.  **Удаление файла по пути**
-    *   **URL**: `/deleteFile?file=<ОТНОСИТЕЛЬНЫЙ_ПУТЬ_К_ФАЙЛУ>`
-        *   Пример: `?file=bot123:abc/photos/file_0.jpg`
-    *   **Метод**: `GET`
-    *   **Ответ**: JSON с результатом операции.
-
-7.  **Удаление файла по ID**
-    *   **URL**: `/<BOT_TOKEN>/deleteById?file_id=<FILE_ID>`
-    *   **Метод**: `GET`
-    *   **Ответ**: JSON с результатом операции.
-
-#### 3.3. Замечания о путях к файлам
-
-*   Локальный `telegram-bot-api` обычно сохраняет файлы в подкаталоге, названном в честь токена бота (например, `/var/lib/telegram-bot-api/bot123:abc/...`).
-*   Относительные пути, используемые в URL инструментов (например, для скачивания или удаления по пути), должны включать эту структуру каталога токена: `bot<TOKEN>/<category>/<filename>`.
+*   **Статистика**: `https://[YOUR_SPACE_URL]/stats`
+*   **Операции с файлами**: Базовый путь `https://[YOUR_SPACE_URL]/file` (см. документацию на корневом URL для деталей по эндпоинтам `/list`, `/<BOT_TOKEN>/getFile`, `/<BOT_TOKEN>/downloadFile`, и т.д.).
 
 ### 4. Информация в Gist
 
-Если настроено, информация о вашем Space и полезные URL будут автоматически обновляться в указанном GitHub Gist (файл `hf_space_tg_tools_info.json`).
+Если настроено, информация о вашем Space и полезные URL будут автоматически обновляться в указанном GitHub Gist (файл `hf_space_telegram_bot_api_proxy_info.json`).
 
 ---
 <br>
 <a id="en"></a>
 
-## 🇬🇧 TgAPIToolsTunnel: Telegram Bot API Proxy with Enhanced Tools
+## 🇬🇧 Telegram Bot API Proxy & Tools
 
-This Space runs a local Telegram Bot API server and provides a feature-rich Node.js proxy application with additional tools.
+This Space runs a local Telegram Bot API server and provides a feature-rich Node.js proxy application with additional tools. Visit the root URL of your Space for interactive documentation.
 
 ### 1. Core Features
 
@@ -183,85 +119,21 @@ Add the following secrets in your Space settings (`Settings -> Secrets`):
 
 ### 3. API Usage
 
-**Your Space Base URL**: `https://[YOUR_SPACE_URL]`
+**Visit the root URL of your Space (`https://[YOUR_SPACE_URL]/`) for interactive API documentation.**
+
+Brief overview:
 
 #### 3.1. Telegram Bot API Proxy
 
 *   **URL**: `https://[YOUR_SPACE_URL]/tg/bot<YOUR_BOT_TOKEN>/<METHOD_NAME>`
-*   **Description**: Use this URL instead of the standard `api.telegram.org`.
-*   **Enhanced Responses**: If an API method returns a file object (e.g., in `result.photo` for `getMe`, or `result` for `getFile`), the response will be automatically augmented with the following fields:
-    *   `direct_download_link_by_path`: Direct link to download the file by its relative path.
-    *   `direct_download_link_by_id`: Direct link to download the file by its ID.
-    *   `delete_link_by_path`: Link to delete the file by its relative path.
-    *   `delete_link_by_id`: Link to delete the file by its ID.
-    *   `encrypted_download_link_by_path` (if `LINK_ENCRYPTION_KEY` is set): Encrypted, time-limited download link by path.
-    *   `encrypted_download_link_by_id` (if `LINK_ENCRYPTION_KEY` is set): Encrypted, time-limited download link by ID.
-*   **Link Expiry Management**:
-    *   Default expiry is set by the `DEFAULT_LINK_EXPIRY_HOURS` variable.
-    *   Can be overridden per request by adding a `?link_expiry_hours=N` query parameter to the proxied request URL (e.g., `.../getMe?link_expiry_hours=2`). `N=-1` for no expiry.
+*   **Description**: Use this URL instead of the standard `api.telegram.org`. API responses containing file information will be automatically augmented with useful links (direct, encrypted, delete).
+*   **Link Expiry Management**: Add a `?link_expiry_hours=N` query parameter to the proxied request URL.
 
 #### 3.2. Management Tools
 
-##### 3.2.1. General Information
-
-*   **URL**: `https://[YOUR_SPACE_URL]/`
-*   **Method**: `GET`
-*   **Response**: JSON describing available endpoints and configuration.
-
-##### 3.2.2. Statistics
-
-*   **URL**: `https://[YOUR_SPACE_URL]/stats`
-*   **Method**: `GET`
-*   **Query Parameters**:
-    *   `run_ttl_now=true` (optional): Trigger old file cleanup immediately.
-*   **Response**: JSON with file statistics for `TELEGRAM_DATA_DIR`.
-
-##### 3.2.3. File Operations (base path: `/file`)
-
-1.  **List Files for a Bot**
-    *   **URL**: `/list?token=<BOT_TOKEN>`
-    *   **Method**: `GET`
-    *   **Response**: JSON with a list of files, their sizes, and total size for the specified bot.
-
-2.  **Get File Info (Enhanced)**
-    *   **URL**: `/<BOT_TOKEN>/getFile?file_id=<FILE_ID>`
-    *   **Method**: `GET`
-    *   **Query Parameters**:
-        *   `link_expiry_hours=N` (optional): Set expiry for generated encrypted links (in hours, `-1` for indefinite).
-    *   **Response**: Standard Telegram API `getFile` response, augmented with links as described in section 3.1.
-
-3.  **Download File by ID**
-    *   **URL**: `/<BOT_TOKEN>/downloadFile?file_id=<FILE_ID>`
-    *   **Method**: `GET`
-    *   **Response**: The file for download.
-
-4.  **Download File by Path**
-    *   **URL**: `/<RELATIVE_PATH_TO_FILE_WITHIN_TELEGRAM_DATA_DIR>`
-        *   Example: `/bot123:abc/photos/file_0.jpg`
-    *   **Method**: `GET`
-    *   **Response**: The file for download.
-
-5.  **Download via Encrypted Link**
-    *   **URL**: `/downloadEncrypted?payload=<ENCRYPTED_PAYLOAD>`
-    *   **Method**: `GET`
-    *   **Response**: The file for download, if the link is valid and not expired.
-
-6.  **Delete File by Path**
-    *   **URL**: `/deleteFile?file=<RELATIVE_FILE_PATH>`
-        *   Example: `?file=bot123:abc/photos/file_0.jpg`
-    *   **Method**: `GET`
-    *   **Response**: JSON with the operation result.
-
-7.  **Delete File by ID**
-    *   **URL**: `/<BOT_TOKEN>/deleteById?file_id=<FILE_ID>`
-    *   **Method**: `GET`
-    *   **Response**: JSON with the operation result.
-
-#### 3.3. Notes on File Paths
-
-*   The local `telegram-bot-api` typically saves files in a subdirectory named after the bot token (e.g., `/var/lib/telegram-bot-api/bot123:abc/...`).
-*   Relative paths used in tool URLs (e.g., for download or delete by path) must include this bot token directory structure: `bot<TOKEN>/<category>/<filename>`.
+*   **Statistics**: `https://[YOUR_SPACE_URL]/stats`
+*   **File Operations**: Base path `https://[YOUR_SPACE_URL]/file` (see documentation at the root URL for details on endpoints like `/list`, `/<BOT_TOKEN>/getFile`, `/<BOT_TOKEN>/downloadFile`, etc.).
 
 ### 4. Gist Information
 
-If configured, information about your Space and useful URLs will be automatically updated in the specified GitHub Gist (file `hf_space_tg_tools_info.json`).
+If configured, information about your Space and useful URLs will be automatically updated in the specified GitHub Gist (file `hf_space_telegram_bot_api_proxy_info.json`).