docs: align README with upstream and add minimal Android sections
This commit is contained in:
parent
09fbc5d876
commit
30f902e0fb
24
README.md
24
README.md
|
|
@ -10,12 +10,10 @@
|
|||
|
||||
# TG WS Proxy
|
||||
|
||||
Локальный SOCKS5-прокси для Telegram Desktop и Android, который перенаправляет трафик через WebSocket-соединения к указанным серверам, помогая частично ускорить работу Telegram.
|
||||
Локальный SOCKS5-прокси для Telegram на Windows и Android, который перенаправляет трафик через WebSocket-соединения к указанным серверам, помогая частично ускорить работу Telegram.
|
||||
|
||||
**Ожидаемый результат аналогичен прокидыванию hosts для Web Telegram**: ускорение загрузки и скачивания файлов, загрузки сообщений и части медиа.
|
||||
|
||||
Этот репозиторий развивает Android-ветку проекта и является форком оригинального TG WS Proxy: [Flowseal/tg-ws-proxy](https://github.com/Flowseal/tg-ws-proxy).
|
||||
|
||||
<img width="529" height="487" alt="image" src="https://github.com/user-attachments/assets/6a4cf683-0df8-43af-86c1-0e8f08682b62" />
|
||||
|
||||
## Как это работает
|
||||
|
|
@ -33,7 +31,7 @@ Telegram Desktop → SOCKS5 (127.0.0.1:1080) → TG WS Proxy → WSS (kws*.web.t
|
|||
## 🚀 Быстрый старт
|
||||
|
||||
### Windows
|
||||
Перейдите на [страницу релизов](https://github.com/Dark-Avery/tg-ws-proxy/releases) и скачайте **`TgWsProxy.exe`**. Он собирается автоматически через [GitHub Actions](https://github.com/Dark-Avery/tg-ws-proxy/actions) из открытого исходного кода.
|
||||
Перейдите на [страницу релизов](https://github.com/Flowseal/tg-ws-proxy/releases) и скачайте **`TgWsProxy.exe`**. Он собирается автоматически через [Github Actions](https://github.com/Flowseal/tg-ws-proxy/actions) из открытого исходного кода.
|
||||
|
||||
При первом запуске откроется окно с инструкцией по подключению Telegram Desktop. Приложение сворачивается в системный трей.
|
||||
|
||||
|
|
@ -45,7 +43,7 @@ Telegram Desktop → SOCKS5 (127.0.0.1:1080) → TG WS Proxy → WSS (kws*.web.t
|
|||
- **Выход** — остановить прокси и закрыть приложение
|
||||
|
||||
### Android
|
||||
Перейдите на [страницу релизов](https://github.com/Dark-Avery/tg-ws-proxy/releases) и скачайте подписанный APK вида **`tg-ws-proxy-android-v1.2.3.apk`**.
|
||||
Перейдите на [страницу релизов](https://github.com/Flowseal/tg-ws-proxy/releases) и скачайте подписанный APK вида **`tg-ws-proxy-android-v1.2.3.apk`**.
|
||||
|
||||
После установки:
|
||||
- откройте приложение
|
||||
|
|
@ -54,19 +52,10 @@ Telegram Desktop → SOCKS5 (127.0.0.1:1080) → TG WS Proxy → WSS (kws*.web.t
|
|||
- нажмите **Start Service**
|
||||
- нажмите **Open in Telegram**
|
||||
|
||||
|
||||
Что уже есть в Android-версии:
|
||||
- foreground service
|
||||
- встроенный Python runtime
|
||||
- кнопка **Open in Telegram** через `tg://socks`
|
||||
- статус ограничений Android
|
||||
- уведомление с кнопкой остановки и статистикой трафика
|
||||
|
||||
Что важно для стабильной работы на Android:
|
||||
- разрешите уведомления
|
||||
- отключите battery optimization для приложения
|
||||
|
||||
|
||||
## Установка из исходников
|
||||
|
||||
```bash
|
||||
|
|
@ -199,13 +188,6 @@ Android хранит рабочие файлы в приватной дирек
|
|||
|
||||
Проект содержит спецификацию PyInstaller ([`windows.spec`](packaging/windows.spec)) и GitHub Actions workflow ([`.github/workflows/build.yml`](.github/workflows/build.yml)) для автоматической сборки.
|
||||
|
||||
Windows-артефакты:
|
||||
- `TgWsProxy.exe`
|
||||
- `TgWsProxy-win7.exe`
|
||||
|
||||
Android-артефакт:
|
||||
- `tg-ws-proxy-android-vX.Y.Z.apk`
|
||||
|
||||
Для signed Android release в GitHub Actions нужны secrets:
|
||||
- `ANDROID_KEYSTORE_BASE64`
|
||||
- `ANDROID_KEYSTORE_PASSWORD`
|
||||
|
|
|
|||
Loading…
Reference in New Issue