first commit

README.md

@@ -1 +1,45 @@
-# 你说的对，但是《原神》是由米哈游自主研发的一款全新开放世界冒险游戏。游戏发生在一个被称作「提瓦特」的幻想世界，在这里，被神选中的人将被授予「神之眼」，导引元素之力。你将扮演一位名为「旅行者」的神秘角色，在自由的旅行中邂逅性格各异、能力独特的同伴们，和他们一起击败强敌，找回失散的亲人——同时，逐步发掘「原神」的真相。
+# ![OpenGFW](docs/logo.png)
+
+[![Quality check status](https://github.com/apernet/OpenGFW/actions/workflows/check.yaml/badge.svg)](https://github.com/apernet/OpenGFW/actions/workflows/check.yaml)
+[![License][1]][2]
+
+[1]: https://img.shields.io/badge/License-MPL_2.0-brightgreen.svg
+[2]: LICENSE
+
+**[中文文档](README.zh.md)**
+**[日本語ドキュメント](README.ja.md)**
+
+OpenGFW is your very own DIY Great Firewall of China (https://en.wikipedia.org/wiki/Great_Firewall), available as a flexible, easy-to-use open source program on Linux. Why let the powers that be have all the fun? It's time to give power to the people and democratize censorship. Bring the thrill of cyber-sovereignty right into your home router and start filtering like a pro - you too can play Big Brother.
+
+**Documentation site: https://gfw.dev/**
+
+Telegram group: https://t.me/OpGFW
+
+> [!CAUTION]
+> This project is still in very early stages of development. Use at your own risk. We are looking for contributors to help us improve and expand the project.
+
+## Features
+
+- Full IP/TCP reassembly, various protocol analyzers
+  - HTTP, TLS, QUIC, DNS, SSH, SOCKS4/5, WireGuard, OpenVPN, and many more to come
+  - "Fully encrypted traffic" detection for Shadowsocks, VMess,
+    etc. (https://gfw.report/publications/usenixsecurity23/en/)
+  - Trojan (proxy protocol) detection
+  - [WIP] Machine learning based traffic classification
+- Full IPv4 and IPv6 support
+- Flow-based multicore load balancing
+- Connection offloading
+- Powerful rule engine based on [expr](https://github.com/expr-lang/expr)
+- Hot-reloadable rules (send `SIGHUP` to reload)
+- Flexible analyzer & modifier framework
+- Extensible IO implementation (only NFQueue for now)
+- [WIP] Web UI
+
+## Use cases
+
+- Ad blocking
+- Parental control
+- Malware protection
+- Abuse prevention for VPN/proxy services
+- Traffic analysis (log only mode)
+- Help you fulfill your dictatorial ambitions