diff --git a/README.md b/README.md index b35a872..23d989a 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,24 @@ # ForNet --- -**v0.0.3 has a terrible bug of error usage of mqtt**, please wait for V0.0.4. +English | [中文](./README_CN.md) -ForNet is another Layer3 Virutal Private Network software, built on top of [BoringTun](https://github.com/cloudflare/boringtun). +ForNet is another Layer3 Virtual Private Network software, built on top of [BoringTun](https://github.com/cloudflare/boringtun). + +currently, it's in `beta` stage + +## Feature +- client code 100% open source, written with Rust. +- self compile, self-hosted, easily integrated with Keycloak, provide admin web to manage clients. +- support UDP/TCP protocol of Wireguard. +- support macOS and Linux, more platform support is on the road. -currently, it's in `beta` stage, supports macOS and Linux, Windows is in blocked for tun driver sign. ## Document -To check out docs, visit [git page](https://fornetcode.github.io/documentation). There's also a [Roadmap](https://fornetcode.github.io/documentation/plan) to show you where the project go. +To check out docs, visit this [Git Page](https://fornetcode.github.io/documentation). There is a [tutorial](https://fornetcode.github.io/documentation/guide/quick-start) for you. +If you are interested with the project future, please refer to [Roadmap](https://fornetcode.github.io/documentation/plan). ## License [BSL 1.1](https://github.com/fornetcode/fornet/blob/main/LICENSE) -Copyright (c) 2023-present, Timzaak +WireGuard is a registered trademark of Jason A. Donenfeld. ForNet is not sponsored or endorsed by Jason A. Donenfeld. \ No newline at end of file diff --git a/README_CN.md b/README_CN.md new file mode 100644 index 0000000..0cba312 --- /dev/null +++ b/README_CN.md @@ -0,0 +1,23 @@ +# ForNet + +--- +[English](./README.md) | 中文 + +ForNet 基于 [BoringTun](https://github.com/cloudflare/boringtun):WireGuard Rust 实现,做了第三层协议组网工具。 + +目前, 它还处于 `实验` 阶段。 + +## 特性 +- 客户端由 Rust 编写,100% 代码开源。 +- 可自行构建、自行部署,提供 web 界面管理客户端,并很容易就和 Keycloak SSO 集成。 +- 支持 UDP/TCP 通信。 +- 目前发布了 Linux 和 macOS 平台客户端,其他平台正在加紧开发中。 + +## 文档 +[文档地址](https://fornetcode.github.io/documentation),快速上手请参见 [Quick Start](https://fornetcode.github.io/documentation/guide/quick-start)。 +若您想了解本项目未来发展方向,请参看 [规划](https://fornetcode.github.io/documentation/plan) 。 + +## License +[BSL 1.1](https://github.com/fornetcode/fornet/blob/main/LICENSE) +--- +WireGuard is a registered trademark of Jason A. Donenfeld. ForNet is not sponsored or endorsed by Jason A. Donenfeld. \ No newline at end of file