From ba1fce2e8713f1a1998bf488ed7c3ff263837227 Mon Sep 17 00:00:00 2001 From: problematicconsumer Date: Fri, 19 Jan 2024 00:00:59 +0330 Subject: [PATCH] Update readme --- README.md | 42 +++++++++++++++--------------------------- 1 file changed, 15 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index bfa05ada..f73e608a 100644 --- a/README.md +++ b/README.md @@ -23,37 +23,30 @@ ## What is Hiddify-Next? -

A multi-platform auto-client based on Sing-box that serves as a universal proxy tool-chain. This app offers a wide range of capabilities, which are listed below. It also supports a large number of protocols. The app is free to use, ad-free, and open-source. It provides a secure and private tool for getting access to the free internet.

- -The app is developed using [Flutter](https://flutter.dev) and [Go](https://go.dev). For more information about development, you can read through our [Contribution Guidelines](CONTRIBUTING.md) . +

A multi-platform proxy client based on Sing-box universal proxy tool-chain. Hiddify Next offers a wide range of capabilities, like automatic node selection, TUN mode, remote profiles etc. Hiddify Next is free and open-source. With support for a wide range of protocols, it provides a secure and private way for accessing free internet.

English Demo -
- ## 🚀 Main features -⭐ Easy to use with a simple UI +✈️ Multi-platform: Android, iOS, Windows, macOS and Linux -✈️ Multi-platform: Android, Windows, Linux and macOS (PRs for iOS are welcome) +⭐ Intuitive and accessible UI -🔍 Auto selection based on delay +🔍 Delay based node selection 🟡 Wide range of protocols: -**ECH, Sing-box, V2ray, Xray, Vless, Vmess, Reality, TUIC, Hysteria, ShadowTLS, SSH, Clash, Clash meta** +Vless, Vmess, Reality, TUIC, Hysteria, SSH etc. -🟡 Subscription links: -**Clash, Clash meta, Sing-box and Shadowsocks** +🟡 Subscription link and configuration formats: Sing-box, V2ray, Clash, Clash meta 🔄 Automatic subscription update 🔎 Display profile information including remaining days and traffic usage -💻 Completely free and without any ads and interruptions - 🛡 Open source, secure and community driven 🌙 Dark and light modes @@ -105,7 +98,8 @@ The app is developed using [Flutter](https://flutter.dev) and [Go](https://go.de ## Installation and tutorials -**Please find tutorial information on our wiki page by clicking on image below.** + +**Find tutorial information on our wiki page by clicking on image below.**
@@ -114,28 +108,26 @@ The app is developed using [Flutter](https://flutter.dev) and [Go](https://go.de
-## Improve Translations +## Translations 🌎
[![inlang status badge](https://inlang.com/badge?url=github.com/hiddify/hiddify-next)](https://inlang.com/editor/github.com/hiddify/hiddify-next?ref=badge)
-You can easily contribute to this project by using the following links to improve the translations: -- [English](https://inlang.com/editor/github.com/hiddify/hiddify-next?lang=en) -- [Persian](https://inlang.com/editor/github.com/hiddify/hiddify-next?lang=en&lang=fa) -- [Russian](https://inlang.com/editor/github.com/hiddify/hiddify-next?lang=en&lang=ru) -- [Chinese](https://inlang.com/editor/github.com/hiddify/hiddify-next?lang=en&lang=zh-CN) -- [Turkish](https://inlang.com/editor/github.com/hiddify/hiddify-next?lang=en&lang=tr) +Improve existing languages or add new ones by manually editing the JSON files located in `/assets/translations` or by using the [Inlang online editor](https://inlang.com/editor/github.com/hiddify/hiddify-next). ## Acknowledgements + We would like to express our sincere appreciation to the contributors of the following projects, whose robust foundation and innovative features have significantly enhanced the success and functionality of this project. + - [Sing-box](https://github.com/SagerNet/sing-box) - [Sing-box for Android](https://github.com/SagerNet/sing-box-for-android) +- [Sing-box for Apple](https://github.com/SagerNet/sing-box-for-apple) - [Clash](https://github.com/Dreamacro/clash) - [Clash Meta](https://github.com/MetaCubeX/Clash.Meta) - [FClash](https://github.com/Fclash/Fclash) -- Font: [Vazirmatn by Saber Rastikerdar](https://github.com/rastikerdar/vazirmatn) +- [Vazirmatn Font by Saber Rastikerdar](https://github.com/rastikerdar/vazirmatn) - [Others](./pubspec.yaml) ## Donation and Support @@ -152,12 +144,8 @@ We also need financial support for our services. All of our activities are done ## Collaboration and Contact Information -We need your collaboration in order to develop this project. If you are specialists in these areas, please do not hesitate to contact us and mention your skill. +Hiddify Next is a community driven project. If you're interested in contributing, please read the [contribution guidelines](./CONTRIBUTING.md). We would specially appreciate any help we can get in these areas: **Flutter, Go, iOS development (Swift), Android development (Kotlin).** -- Flutter Developing -- Swift Developing -- Kotlin Developing -- Go Developing