docs: update README with features and performance improvements
This commit is contained in:
17
README_zh.md
17
README_zh.md
@@ -4,10 +4,21 @@
|
||||
|
||||
**此项目是 Dragon's Zone HomeLab 的一部分**
|
||||
|
||||
本项目的侧重于功能实现,并未考虑任何性能优化,亦未考虑大规模部署的情况,由此带来的任何问题与项目无关。
|
||||
本项目致力于提供高性能、安全且可扩展的 Gitea Pages 服务。
|
||||
|
||||
**注意**:此项目已经被完全重构,不兼容 `0.0.1` 版本升级
|
||||
|
||||
## 特性
|
||||
|
||||
- [x] **高性能**: 采用 JS 预编译缓存和高效的异步 Promise 处理机制。
|
||||
- [x] **安全**: 内置模板和文件访问的路径穿越保护。
|
||||
- [x] **内容缓存**: 多级元数据和二进制内容缓存。
|
||||
- [x] **CNAME**: 支持自定义域名。
|
||||
- [x] **模板引擎**: 安全的模板渲染,支持 `load` 动态加载。
|
||||
- [x] **可编程**: 使用 JavaScript (Goja) 编写自定义路由逻辑。
|
||||
- [x] **反向代理**: 支持将请求代理到后端服务。
|
||||
|
||||
|
||||
## Get Started
|
||||
|
||||
安装 `go1.25` 或更高版本,同时安装 `Make` 工具 ,然后执行如下命令:
|
||||
@@ -40,10 +51,6 @@ routes:
|
||||
|
||||
## TODO
|
||||
|
||||
- [x] 内容缓存
|
||||
- [x] CNAME 自定义域名
|
||||
- [x] 模板渲染
|
||||
- [x] 反向代理请求
|
||||
- [ ] 支持跨域
|
||||
- [ ] 支持自定义缓存策略 (http cache-control)
|
||||
- [ ] OAuth2 授权访问私有页面
|
||||
|
||||
Reference in New Issue
Block a user