Skip to content

Update README.md with project overview and platform details #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Cbowcrptex wants to merge 1 commit into
base: main
Choose a base branch
from
+40 −28
Open

Update README.md with project overview and platform details #80

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 40 additions & 28 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,42 @@
# Happ - Proxy Utility

| iOS | Android | Desktop |
| -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- |
| [App Store-Global](https://apps.apple.com/us/app/happ-proxy-utility/id6504287215) | [Google Play](https://play.google.com/store/apps/details?id=com.happproxy) | [Windows](https://github.com/Happ-proxy/happ-desktop/releases/latest/download/setup-Happ.x64.exe)/[mirror](https://files-hub.com/download/windows/latest?arch=x64) |
| [App Store-Only RU](https://apps.apple.com/ru/app/happ-proxy-utility-plus/id6746188973) | [Download APK](https://github.com/Happ-proxy/happ-android/releases/latest/download/Happ.apk)/[mirror](https://files-hub.com/download/android/latest?arch=universal) | [macOS(arm64/intel)](https://github.com/Happ-proxy/happ-desktop/releases/latest/download/Happ.macOS.universal.dmg)/[mirror](https://files-hub.com/download/macos/latest?arch=universal)|
| [Testflight-Global](https://testflight.apple.com/join/XMls6Ckd) | [Download Beta APK](https://github.com/Happ-proxy/happ-android/releases/latest/download/Happ_beta.apk) | [Linux-x64(.deb)](https://github.com/Happ-proxy/happ-desktop/releases/latest/download/Happ.linux.x64.deb)/[mirror](https://files-hub.com/download/linux/latest?arch=x64&package=deb) |
| [Testflight-Only RU](https://testflight.apple.com/join/1bKEcMub) | | [Linux-arm64(.deb)](https://github.com/Happ-proxy/happ-desktop/releases/latest/download/Happ.linux.arm64.deb)/[mirror](https://files-hub.com/download/linux/latest?arch=arm64&package=deb) |
| | | [Linux-x64(.rpm)](https://github.com/Happ-proxy/happ-desktop/releases/latest/download/Happ.linux.x64.rpm)/[mirror](https://files-hub.com/download/linux/latest?arch=x64&package=rpm) |
| | | [Linux-arm64(.rpm)](https://github.com/Happ-proxy/happ-desktop/releases/latest/download/Happ.linux.arm64.rpm)/[mirror](https://files-hub.com/download/linux/latest?arch=arm64&package=rpm) |
| | | [ArchLinux-x64(.pkg)](https://github.com/Happ-proxy/happ-desktop/releases/latest/download/Happ.linux.x64.pkg.tar.zst)/[mirror](https://files-hub.com/download/linux/latest?arch=x64&package=pkg) |
| | | [ArchLinux-arm64(.pkg)](https://github.com/Happ-proxy/happ-desktop/releases/latest/download/Happ.linux.arm64.pkg.tar.zst)/[mirror](https://files-hub.com/download/linux/latest?arch=arm64&package=pkg) |

Happ is a mobile application designed for convenient proxy server management, powered by the robust Xray core. The app features an intuitive interface and a range of useful functions, making it an essential tool for managing connections.

**Key features of Happ include:**

* Configuration of proxy servers based on flexible routing rules.
* Support for multiple modern protocols, including:
* **VLESS (Reality)**
* **VMess**
* **Trojan**
* **Shadowsocks**
* **Socks**

Happ ensures your network activity remains private by not collecting any data; your information remains solely on your device without being sent to external servers.

It's important to highlight that Happ does not provide VPN services for purchase. Users are responsible for acquiring or setting up their own servers. Users should also comply with applicable laws in their jurisdiction when utilizing the app.

To report a problem, use our [service](https://issues.happ.su/)
A lightweight and powerful proxy utility for secure and private browsing.

## 📱 Platforms

| Platform | Status | Download | Documentation |
|------------|-------------|----------|---------------|
| **iOS** | Available | [App Store]() | [iOS Guide](./docs/ios.md) |
| **Android**| Available | [Google Play]() / [APK]() | [Android Guide](./docs/android.md) |
| **Desktop**| Available | [Download for macOS]() • [Windows]() • [Linux]() | [Desktop Guide](./docs/desktop.md) |

---

## ✨ Features

- Fast and reliable proxy connections
- Multiple protocol support (HTTP, SOCKS5, Shadowsocks, etc.)
- User-friendly interface
- Cross-platform synchronization
- Privacy focused with no-logs policy

## 🚀 Quick Start (Desktop)

1. Download and install the latest version for your operating system.
2. Launch **Happ Desktop**.
3. Connect to a server or add your own proxy configuration.
4. Enjoy secure browsing!

## 📖 Documentation

- [Installation Guide](./docs/install.md)
- [Configuration](./docs/configuration.md)
- [Troubleshooting](./docs/troubleshooting.md)
- [FAQ](./docs/faq.md)

## 🛠 Development

```bash
git clone https://github.com/yourusername/happ-desktop.git
cd happ-desktop
# Follow platform-specific setup