From c2efbf37006704c1335627a0304e63924d383d80 Mon Sep 17 00:00:00 2001 From: timzaak Date: Fri, 19 May 2023 17:11:18 +0800 Subject: [PATCH 1/4] improve readme,add cn readme --- README.md | 13 +++++++++++-- README_CN.md | 22 ++++++++++++++++++++++ 2 files changed, 33 insertions(+), 2 deletions(-) create mode 100644 README_CN.md diff --git a/README.md b/README.md index dd770ac..f819416 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,18 @@ # ForNet --- +English | [中文](./README_CN.md) ForNet is another Layer3 Virutal Private Network software, built on top of [BoringTun](https://github.com/cloudflare/boringtun). -currently, it's in `beta` stage, supports macOS and Linux， Windows is in blocked for tun driver sign. +currently, it's in `beta` stage + +## Feature +- client code 100% open source, written with Rust. +- self compile, self hosted, easily intergated with Keycloak, provide admin web to manage clients. +- support UDP/TCP potocol of Wireguard. +- support macOS and Linux, more platform support is on the road. + ## 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. @@ -12,4 +20,5 @@ To check out docs, visit [git page](https://fornetcode.github.io/documentation). ## License [BSL 1.1](https://github.com/fornetcode/fornet/blob/main/LICENSE) -Copyright (c) 2023-present, Timzaak \ No newline at end of file +--- +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..fe0d6ae --- /dev/null +++ b/README_CN.md @@ -0,0 +1,22 @@ +# ForNet + +--- +[English](./README.md) | 中文 + +ForNet 基于 [BoringTun](https://github.com/cloudflare/boringtun)：一个 WireGuard Rust 实现，做了类似 OpenVPN 的第三层协议组网工具。 + +目前, 它还处于 `实验` 阶段。 + +## 功能 +- 客户端由 Rust 编写，100% 代码开源。 +- 可自行构建、自行部署，提供 web 界面管理客户端，并很容易就和 Keycloak SSO 集成。 +- 支持 UDP/TCP 的 Wiregard 通信。 +- 客户端目前发布了 Linux 和 macOS 平台，其他平台正在加紧开发中。 + +## 文档 +[文档地址](https://fornetcode.github.io/documentation)。 如果您想了解本项目未来发展方向，请参看 [规划](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 From fe041e3fb5deac6afd1fc3a33acb8b4787262421 Mon Sep 17 00:00:00 2001 From: timzaak Date: Mon, 22 May 2023 13:45:15 +0800 Subject: [PATCH 2/4] bak --- README.md | 4 +++- README_CN.md | 7 ++++--- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f819416..97e8823 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,9 @@ currently, it's in `beta` stage ## 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 diff --git a/README_CN.md b/README_CN.md index fe0d6ae..48caeee 100644 --- a/README_CN.md +++ b/README_CN.md @@ -3,18 +3,19 @@ --- [English](./README.md) | 中文 -ForNet 基于 [BoringTun](https://github.com/cloudflare/boringtun)：一个 WireGuard Rust 实现，做了类似 OpenVPN 的第三层协议组网工具。 +ForNet 基于 [BoringTun](https://github.com/cloudflare/boringtun)：WireGuard Rust 实现，做了第三层协议组网工具。 目前, 它还处于 `实验` 阶段。 -## 功能 +## 特性 - 客户端由 Rust 编写，100% 代码开源。 - 可自行构建、自行部署，提供 web 界面管理客户端，并很容易就和 Keycloak SSO 集成。 - 支持 UDP/TCP 的 Wiregard 通信。 - 客户端目前发布了 Linux 和 macOS 平台，其他平台正在加紧开发中。 ## 文档 -[文档地址](https://fornetcode.github.io/documentation)。 如果您想了解本项目未来发展方向，请参看 [规划](https://fornetcode.github.io/documentation/plan) 。 +[文档地址](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) From b23fd45bcc6c0a43be63284f038d202844b1b0fb Mon Sep 17 00:00:00 2001 From: timzaak Date: Mon, 5 Jun 2023 17:43:21 +0800 Subject: [PATCH 3/4] bak it --- README.md | 1 - README_CN.md | 6 +++--- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 97e8823..7ac3684 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,6 @@ To check out docs, visit this [Git Page](https://fornetcode.github.io/documentat 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) --- diff --git a/README_CN.md b/README_CN.md index 48caeee..0cba312 100644 --- a/README_CN.md +++ b/README_CN.md @@ -10,11 +10,11 @@ ForNet 基于 [BoringTun](https://github.com/cloudflare/boringtun)：WireGuard R ## 特性 - 客户端由 Rust 编写，100% 代码开源。 - 可自行构建、自行部署，提供 web 界面管理客户端，并很容易就和 Keycloak SSO 集成。 -- 支持 UDP/TCP 的 Wiregard 通信。 -- 客户端目前发布了 Linux 和 macOS 平台，其他平台正在加紧开发中。 +- 支持 UDP/TCP 通信。 +- 目前发布了 Linux 和 macOS 平台客户端，其他平台正在加紧开发中。 ## 文档 -[文档地址](https://fornetcode.github.io/documentation)，快速上手请参见 [quick start](https://fornetcode.github.io/documentation/guide/quick-start)。 +[文档地址](https://fornetcode.github.io/documentation)，快速上手请参见 [Quick Start](https://fornetcode.github.io/documentation/guide/quick-start)。 若您想了解本项目未来发展方向，请参看 [规划](https://fornetcode.github.io/documentation/plan) 。 ## License From 9831e620e074320b7faf729614247db47424335a Mon Sep 17 00:00:00 2001 From: timzaak Date: Thu, 15 Jun 2023 16:17:30 +0800 Subject: [PATCH 4/4] fix typo --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 75dfbcc..23d989a 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,14 @@ --- 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 intergated with Keycloak, provide admin web to manage clients. -- support UDP/TCP potocol of Wireguard. +- 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.