Update README.md

Author: rtmelsov

README.md

@@ -1,123 +1,79 @@
-Adv Keeper — «еле-еле, но работает»
+# ADV Keeper (CLI/TUI)
 
-Маленький демо-проект: gRPC-сервер + TUI-клиент (Go) для регистрации/логина и загрузки/скачивания файлов.
-План был «сделать за неделю», получилось «сделали — и это уже праздник»
+Лёгкий офлайн-клиент для загрузки и скачивания файлов через gRPC с удобным TUI-интерфейсом на Bubble Tea.  
+**Ничего ставить не нужно, кроме `make` и вашей ОС.**
 
-Что умеет
+## Быстрый старт
 
-Регистрация и логин (пароли в БД, клиент хранит только сессию).
+```bash
+# 1) Запуск сервера
+make server   # или make run-server / make run — смотрите цели в Makefile
+```
+# 2) В другом терминале — запуск TUI-клиента
+make tui      # или make run-tui / make client — по Makefile
+Если в вашем Makefile другие имена целей — используйте их. Смысл простой: одна цель стартует сервер, другая — клиент.
 
-JWT-авторизация на сервере.
+Учётная запись (демо)
+Войти можно тестовым аккаунтом:
 
-Загрузка/скачивание файлов с прогрессом.
+makefile
+Copy code
+Логин:    admin
+Пароль:   admin
+Как пользоваться
+Загрузка файла (Upload)
+В главном меню выберите Upload (стрелки ↑/↓, Enter).
 
-Кроссплатформенный TUI (Linux / macOS / Windows).
+Выберите файл через встроенный файловый диалог.
 
-Автомиграции БД при старте сервера.
+Во время загрузки увидите:
 
-systemd-юнит для деплоя (чтобы «само вставало и работало… ну почти»).
+прогресс-бар, проценты,
 
-Быстрый старт (клиент)
+скорость передачи и ETA,
 
-Клиенту нужна одна переменная окружения: AK_GRPC_ADDR — адрес gRPC сервера, например 89.207.255.214:8080.
+подсказку ESC — отмена.
 
-Windows (PowerShell)
-$env:AK_GRPC_ADDR = "89.207.255.214:8080"
-.\tui_windows_amd64.exe
+По завершении вернёт в список файлов (FileList).
 
+Скачивание файла (Download)
+Откройте FileList.
 
-Сделать навсегда:
+Стрелками выберите нужный файл, Enter → Download.
 
-[Environment]::SetEnvironmentVariable(
-  "AK_GRPC_ADDR","89.207.255.214:8080",[EnvironmentVariableTarget]::User
-)
+Прогресс отображается так же, как при upload.
 
-macOS / Linux
-export AK_GRPC_ADDR=89.207.255.214:8080
-./tui                   # или ./tui_darwin_arm64, ./tui_linux_amd64
+Готовый файл сохраняется рядом с приложением (в текущей папке, где запущен клиент/бинарь).
 
+Если не уверены, где окажется файл — посмотрите текущую директорию (pwd на macOS/Linux или cd без аргументов в Windows).
 
-Опционально: куда сохранять скачанные файлы
+Клавиши
+↑ / ↓ / j / k — навигация по меню/таблицам
 
-export AK_FILES_DIR="$HOME/Downloads/adv-keeper"
+Enter — выбрать
 
+ESC — назад/отмена/снять фокус
 
-Навигация в TUI: ↑/↓ и Enter. После логина сессия лежит в:
+Ctrl+C — выход
 
-Linux/macOS: ~/.config/adv-keeper/session.json
+Во время загрузки/скачивания:
 
-Windows: %AppData%\adv-keeper\session.json
+ESC — отменить операцию
 
-Сборка клиента
+Что внутри (коротко)
+gRPC сервер и TUI-клиент.
 
-Требуется Go 1.22+.
+Передача файлов чанками, с расчётом прогресса/скорости/ETA.
 
-make build    # текущая платформа -> ./dist/tui
-make linux    # linux_amd64
-make mac      # darwin_arm64 (Apple Silicon)
-make windows  # windows_amd64.exe
+Сессия сохраняется и очищается при Logout.
 
-Сервер (шпаргалка владельцу)
-.env
-# /etc/adv-keeper.env
-AK_GRPC_ADDR=0.0.0.0:8080
-DB_DSN=postgres://admin:admin@127.0.0.1:5432/adv?sslmode=disable
-JWT_SECRET=super-secret-not-for-git
-FILES_DIR=/opt/adv-keeper/data
-MIGRATIONS_PATH=file:///opt/adv-keeper/migrations
+Демо-видео
+В качестве примера можно взять видео с Дуэйном Джонсоном (The Rock):
+https://www.youtube.com/watch?v=skeQ9C7JuG4
 
-systemd unit
-# /etc/systemd/system/adv-keeper.service
-[Unit]
-Description=Adv Keeper Server
-After=network.target
-Requires=postgresql.service
+Траблшутинг
+“Висит загрузка” — убедитесь, что сервер запущен до старта клиента.
 
-[Service]
-User=ak
-Group=ak
-EnvironmentFile=/etc/adv-keeper.env
-WorkingDirectory=/opt/adv-keeper
-ExecStart=/opt/adv-keeper/current
-Restart=always
-RestartSec=2
-LimitNOFILE=65535
+“Не логинится” — проверьте демо-логин/пароль admin/admin.
 
-[Install]
-WantedBy=multi-user.target
-
-
-Развёртывание (у нас через GitHub Actions) кладёт бинарь в /opt/adv-keeper/releases/<server-TS>, двигает current и рестартит сервис.
-Миграции берутся из MIGRATIONS_PATH.
-
-Проверки:
-
-sudo systemctl status adv-keeper --no-pager
-journalctl -u adv-keeper -n 100 --no-pager
-ss -ltnp 'sport = :8080'         # слушает ли порт
-
-
-Открыть порт наружу (UFW):
-
-sudo ufw allow 8080/tcp
-sudo ufw status
-
-FAQ
-
-connection refused
-На сервере AK_GRPC_ADDR=0.0.0.0:8080, порт открыт, сервис запущен.
-
-Дисклеймер безопасности
-
-Это демо. Порт 8080 может быть открыт, JWT секрет — в переменных окружения, логика — нарочно упрощена.
-Не храните чувствительные данные, только тестовые!!!
-
-Статус
-
-«Работает у меня на облаке»
-
-⚠️ «Улучшить можно всё»
-
-🥳 «Но оно живёт, и это главное»
-
-Если что-то не взлетело — заводите issue. Если взлетело — тоже заводите, нам нужна моральная поддержка. 🙌
+“Не вижу скачанного файла” — проверьте текущую директорию клиента; файл сохраняется рядом с бинарём.