README.md

@@ -1,20 +1,74 @@
-# Чат-робот STCS
-__
+Crypto Trading Telegram Bot
 
-**Функционал:**
-+ **Настройки**
-  + Основные параметры *(Настроен, работает)*
-    + Режим торговли Лонг/Шорт *(настроены)*, Switch/Smart *(не настроены)*
-    + Тип маржи: Изолированная / Кросс *(настроено)*
-    + Размер кредитного плеча: от x1 до x100 *(настроено)*
-    + Начальная ставка: числовое значение *(настроено)*
-    + Коэффициент мартингейла: число *(настроено)*
-    + Максимальное количество ставок в серии: число *(настроено)*
-  + Риск-менеджмент (Настроен, работает)
-    + Процент изменения цены для фиксации прибыли (TP%): число *(настроено)*
-    + Процент изменения цены для фиксации убытков (SL%): число (пример: 1%) *(настроено)*
-    + Максимальный риск на сделку (в % от баланса): число (опционально) *(настроено)*
-   + Условия запуска *(Не настроен)*
-   + Дополнительные параметры *(Не настроен)*
-   + Подключение Bybit *(настроено)*
-    + Информация о правильном получении и сохранении Bybit-API keys *(настроено)*
+Этот бот — автоматизированный торговый помощник для работы с криптовалютной биржей Bybit на основе стратегии мартингейла. Он позволяет торговать бессрочными контрактами с управлением рисками, тейк-профитами, стоп-лоссами и кредитным плечом.
+
+##Основные возможности
+
+- Поддержка работы с биржей Bybit через официальный API.
+
+- Открытие и закрытие позиций по выбранным торговым парам.
+
+- Поддержка рыночных и лимитных ордеров.
+
+- Установка уровней тейк-профита (TP) и стоп-лосса (SL).
+
+- Управление кредитным плечом (leverage).
+
+- Реализация стратегии мартингейла с настройками шага, коэффициента и лимитов.
+
+- Контроль максимального риска на сделку по балансу пользователя.
+
+- Обработка ошибок API, логирование событий и информирование пользователя.
+
+- Таймеры для отложенного открытия и закрытия сделок.
+
+- Интерактивное меню и ввод настроек через Telegram.
+
+- Хранение пользовательских настроек и статистики в базе данных.
+
+
+##Установка и запуск
+
+1. Клонируйте репозиторий:
+
+
+git clone <URL_репозитория>
+
+
+2. Установите зависимости:
+
+pip install -r requirements.txt
+
+
+3. Создайте файл .env и настройте переменные окружения.
+
+
+4. Запустите бота:
+
+python BybitBot_API.py
+
+
+##Настройки пользователя
+
+- Кредитное плечо (например, 15x)
+
+- Торговая пара (например, DOGEUSDT, BTCUSDT)
+
+- Начальное количество для сделок
+
+- Тип ордера (Market или Limit)
+
+- Уровни Take Profit и Stop Loss (в процентах или цене)
+
+- Коэффициент мартингейла и максимальное количество шагов
+
+- Максимально допустимый риск на одну сделку (% от баланса)
+
+- Таймеры для старта и закрытия сделок
+
+
+##Безопасность и риски
+
+- Бот требует аккуратной настройки параметров риска.
+
+- Храните API ключи в безопасности, избегайте публикации.