Skip to content

Commit 2e71e52

Browse files
authored
readme improve for v0.1.0 (#29)
1 parent 68ca0b3 commit 2e71e52

File tree

2 files changed

+23
-16
lines changed

2 files changed

+23
-16
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,23 @@ English | [中文](./README_CN.md)
55

66
ForNet is another Layer3 Virtual Private Network software, built on top of [BoringTun](https://github.com/cloudflare/boringtun).
77

8-
Currently, it's in `beta` stage
8+
Currently, it's in `beta` stage.
99

10-
## Feature
10+
### Feature
1111
- client code 100% open source, written with Rust.
1212
- self compile, self-hosted, easily integrated with Keycloak, provide admin web to manage clients.
1313
- support UDP/TCP protocol of Wireguard.
14-
- support macOS and Linux, more platform support is on the road.
14+
- support macOS, Linux and Windows, Android platform support is on the road.
1515

1616

17-
## Document
18-
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.
17+
### Document
18+
To check out docs, visit this [site](https://doc.fornetcode.com). There is a [quick start tutorial](https://doc.fornetcode.com/guide/quick-start) for you.
1919

20-
If you are interested with the project future, please refer to [Roadmap](https://fornetcode.github.io/documentation/plan).
20+
If you are interested with the project future, please refer to [Roadmap](https://doc.fornetcode.com/plan).
2121

22-
## License
22+
If you want build it yourself, please ref [Develop Guide](https://doc.fornetcode.com/guide/develop)
23+
24+
### License
2325
[BSL 1.1](https://github.com/fornetcode/fornet/blob/main/LICENSE)
2426

2527
<sub>WireGuard is a registered trademark of Jason A. Donenfeld. ForNet is not sponsored or endorsed by Jason A. Donenfeld.</sub>

README_CN.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,28 @@
11
# ForNet
22

3-
43
[English](./README.md) | 中文
54

65
ForNet 基于 [BoringTun](https://github.com/cloudflare/boringtun):WireGuard Rust 实现,做了第三层协议组网工具。
76

87
目前, 它还处于 `实验` 阶段。
98

10-
## 特性
9+
### 特性
1110
- 客户端由 Rust 编写,100% 代码开源。
12-
- 可自行构建、自行部署,提供 web 界面管理客户端,并很容易就和 Keycloak SSO 集成。
13-
- 支持 UDP/TCP 通信。
14-
- 目前发布了 Linux 和 macOS 平台客户端,其他平台正在加紧开发中。
11+
- 可自行构建、自行部署,提供 web 界面管理客户端,与 Keycloak SSO 集成简便。
12+
- 支持 UDP/TCP 双协议,解决特殊地区对 UDP 的封锁。
13+
- 发布了 Linux、macOS、Windows 平台二进制客户端和 Linux Docker 镜像,方便部署,Android 平台正在加紧开发中。
14+
15+
### 快速开始
16+
1. 打开控制平台网页: [ForNet Admin](https://sso.fornetcode.com), 注册账号,并前往邮箱激活。
17+
2. 激活后,进入控制平台,创建网络,获得加入该网络邀请链接。
18+
3. 前往 [Github Release](https://github.com/ForNetCode/fornet/releases),按平台下载对应客户端,并解压到特定目录。
19+
4. `sudo fornet join xxx`, 加入网络,并前往控制平台,激活该设备。
1520

16-
## 文档
17-
[文档地址](https://fornetcode.github.io/documentation),快速上手请参见 [Quick Start](https://fornetcode.github.io/documentation/guide/quick-start)
18-
若您想了解本项目未来发展方向,请参看 [规划](https://fornetcode.github.io/documentation/plan)
21+
### 文档
22+
[文档地址](https://doc.fornetcode.com),快速上手请参见 [Quick Start](https://doc.fornetcode.com/guide/quick-start)
23+
若您还想了解本项目未来发展方向,请参看 [项目规划](https://doc.fornetcode.com/plan)
1924

20-
## License
25+
### License
2126
[BSL 1.1](https://github.com/fornetcode/fornet/blob/main/LICENSE)
2227

2328
<sub>WireGuard is a registered trademark of Jason A. Donenfeld. ForNet is not sponsored or endorsed by Jason A. Donenfeld.</sub>

0 commit comments

Comments
 (0)