From dadf6bf0ab964a29a671a629f25159207c666401 Mon Sep 17 00:00:00 2001 From: Toby Date: Fri, 1 Sep 2023 17:51:44 -0700 Subject: [PATCH] chore: update README --- CHANGELOG.md | 3 ++ README.md | 101 +++++++++++++++++++++++++-------------------------- logo.svg | 1 + 3 files changed, 53 insertions(+), 52 deletions(-) create mode 100644 CHANGELOG.md create mode 100644 logo.svg diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..6f7a980 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,3 @@ +# Changelog + +https://v2.hysteria.network/docs/Changelog/ diff --git a/README.md b/README.md index 9515d68..b4470bd 100644 --- a/README.md +++ b/README.md @@ -1,62 +1,59 @@ -# Hysteria 2 Prototype +# Hysteria 2 -> **Warning** -> The code on this branch is a work-in-progress prototype of what will become Hysteria 2.0. It is currently very -> unfinished, and unless you know what you are doing, you should stick with the stable 1.x releases for now. +![Logo](logo.svg) -> **警告** -> 此分支的代码是 Hysteria 2.0 的原型，目前仍在开发中，完成度十分有限。除非你十分确定自己在做什么，否则请继续使用稳定的 1.x -> 版本。 +[![License][1]][2] [![Release][3]][4] [![Telegram][5]][6] [![Discussions][7]][8] -## Build (编译) +[1]: https://img.shields.io/badge/license-MIT-blue +[2]: LICENSE.md +[3]: https://img.shields.io/github/v/release/apernet/hysteria?style=flat-square +[4]: https://github.com/apernet/hysteria/releases +[5]: https://img.shields.io/badge/chat-Telegram-blue?style=flat-square +[6]: https://t.me/hysteria_github +[7]: https://img.shields.io/github/discussions/apernet/hysteria?style=flat-square +[8]: https://github.com/apernet/hysteria/discussions -Use the environment variable `HY_APP_PLATFORMS` to control which platforms to build for. For -example: `"windows/amd64,linux/amd64,linux/arm"` +

Hysteria is a powerful, lightning fast and censorship resistant proxy.

-用环境变量 `HY_APP_PLATFORMS` 来控制编译哪些平台的可执行文件。例如：`"windows/amd64,linux/amd64,linux/arm"` +

+ + Get Started + + + 中文文档 + +

-```bash -python ./hyperbole.py build -``` +--- -Builds will be placed in `./build` (编译输出在 `./build` 目录下) +
+
+

🛠️ Packed to the gills

+

Expansive range of modes including SOCKS5, HTTP proxy, TCP/UDP forwarding, Linux TProxy - not to mention additional features continually being added.

+
-## Usage (使用) +
+

⚡ Lightning fast

+

Powered by a custom QUIC protocol, Hysteria delivers unparalleled performance over even the most unreliable and lossy networks.

+
-### Server +
+

✊ Censorship resistant

+

Our protocol is designed to masquerade as standard HTTP/3 traffic, making it very difficult to detect and block without widespread collateral damage.

+
+ +
+

💻 Cross-platform

+

We have builds for all major platforms and architectures. Deploy anywhere & use everywhere.

+
-```bash -./hysteria server -c config.yaml -``` - -[Example sever config (示例服务器配置)](app/server.example.yaml) - -### Client - -```bash -./hysteria client -c config.yaml -``` - -[Example client config (示例客户端配置)](app/client.example.yaml) - -## Logging (日志) - -The following environment variables for controlling logging are supported: - -- `HYSTERIA_LOG_LEVEL` - supported values are `debug`, `info`, `warn`, `error` - -- `HYSTERIA_LOG_FORMAT` - supported values are `console`, `json` - -支持通过以下环境变量来控制日志： - -- `HYSTERIA_LOG_LEVEL` - 支持的值有 `debug`, `info`, `warn`, `error` - -- `HYSTERIA_LOG_FORMAT` - 支持的值有 `console`, `json` - -## Test HTTP/3 masquerading (测试 HTTP/3 伪装) - -```bash -chrome --origin-to-force-quic-on=example.com:443 -``` - -Then visit `https://example.com/` in Chrome. \ No newline at end of file +
+

🔗 Easy integration

+

With built-in support for custom authentication, traffic statistics & access control, Hysteria is easy to integrate into your infrastructure.

+
+ +
+

🤗 Open standards

+

We have well-documented specifications and code for developers to contribute and build their own apps.

+
+
diff --git a/logo.svg b/logo.svg new file mode 100644 index 0000000..9c85c9c --- /dev/null +++ b/logo.svg @@ -0,0 +1 @@ + \ No newline at end of file