Skip to content

Commit 7e8de92

Browse files
authored
chore: Update README.md
1 parent 99e5bcd commit 7e8de92

File tree

1 file changed

+73
-60
lines changed

1 file changed

+73
-60
lines changed

README.md

+73-60
Original file line numberDiff line numberDiff line change
@@ -1,107 +1,120 @@
11
<div align="center">
2-
<h1>
3-
<b>Sublink Worker</b>
4-
</h1>
2+
<h1><b>Sublink Worker</b></h1>
3+
<h5><i>Serverless 自部署订阅转换工具最佳实践</i></h5>
4+
5+
<a href="https://trendshift.io/repositories/12291" target="_blank">
6+
<img src="https://trendshift.io/api/badge/repositories/12291" alt="7Sageer%2Fsublink-worker | Trendshift" width="250" height="55"/>
7+
</a>
8+
9+
<p>
10+
<a href="https://sublink-worker.sageer.me">https://sublink-worker.sageer.me</a>
11+
</p>
512
</div>
613

14+
## ✨ 功能特点
715

8-
<div align="center">
9-
<h5>
10-
<i>Serverless 自部署订阅转换工具最佳实践</i>
11-
</h5>
12-
</div>
13-
14-
<div align="center">
15-
<href>
16-
https://sublink-worker.sageer.me
17-
</href>
18-
</div>
19-
20-
## 功能特点
16+
### 支持协议
17+
- ShadowSocks
18+
- VMess
19+
- VLESS
20+
- Hysteria2
21+
- Trojan
22+
- TUIC
2123

22-
- 支持协议:ShadowSocks, VMess, VLESS, Hysteria2, Trojan, TUIC
24+
### 核心功能
2325
- 支持导入 Base64 的 http/https 订阅链接
2426
- 一键部署,Vanilla JS + Cloudflare Worker,无需后端
25-
- 支持客户端:
26-
- Sing-Box
27-
- Clash
28-
- Xray/V2Ray
2927
- 支持固定/随机短链接生成(基于 KV)
3028
- 浅色/深色主题切换
3129
- 灵活的 API,支持脚本化操作
32-
- 用户友好的 Web 界面,灵活的自定义规则
33-
- 提供多种预定义规则集
34-
- 可自建关于geo-site, geo-ip, ip-cidr和domain-suffix的自定义策略组
3530

36-
## 部署
31+
### 客户端支持
32+
- Sing-Box
33+
- Clash
34+
- Xray/V2Ray
3735

38-
### (推荐)自动部署
36+
### Web 界面特性
37+
- 用户友好的操作界面
38+
- 提供多种预定义规则集
39+
- 可自建关于 geo-site、geo-ip、ip-cidr 和 domain-suffix 的自定义策略组
3940

41+
## 🚀 部署指南
42+
43+
### 推荐:自动部署
4044
[![Deploy to Cloudflare Workers](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/7Sageer/sublink-worker)
4145

4246
### 手动部署
47+
1. 克隆项目仓库:
48+
```bash
49+
git clone https://github.com/7Sageer/sublink-worker.git
50+
```
51+
2. 安装依赖:
52+
```bash
53+
npm install
54+
```
55+
3. 配置 Cloudflare 账户凭证
56+
4. 使用 Wrangler 部署:
57+
```bash
58+
wrangler deploy
59+
```
60+
61+
### 新手指南
62+
- [视频教程1](https://www.youtube.com/watch?v=ZTgDm4qReyA)
63+
- [视频教程2](https://www.youtube.com/watch?v=7abmWqCXPR8)
4364

44-
- 克隆项目仓库:`git clone https://github.com/7Sageer/sublink-worker.git`
45-
- 安装依赖:`npm install`
46-
- 配置 Cloudflare 账户凭证
47-
- 使用 Wrangler 部署:`wrangler deploy`
48-
49-
### 新手?
50-
#### [视频教程1](https://www.youtube.com/watch?v=ZTgDm4qReyA)
51-
#### [视频教程2](https://www.youtube.com/watch?v=7abmWqCXPR8)
5265
> 💡 这些是由社区成员制作的教程视频,详细的讲解可以让你快速上手。但是部分内容可能与我们的见解不同,也可能与最新版本存在差异,建议同时参考[官方文档](/docs)
53-
#### [官方FAQ](/docs/FAQ.md)
5466
55-
## API 文档
67+
- [官方FAQ](/docs/FAQ.md)
5668

57-
详细的 API 文档可以在 [API-doc.md](/docs/API-doc.md) 中找到。
69+
## 📖 API 文档
5870

59-
主要端点包括:
71+
详细的 API 文档请参考 [API-doc.md](/docs/API-doc.md)
6072

61-
- `/singbox`:生成 Sing-Box 配置
62-
- `/clash`:生成 Clash 配置
63-
- `/xray`:生成 Xray 配置
64-
- `/shorten`:生成短链接
73+
### 主要端点
74+
- `/singbox` - 生成 Sing-Box 配置
75+
- `/clash` - 生成 Clash 配置
76+
- `/xray` - 生成 Xray 配置
77+
- `/shorten` - 生成短链接
6578

66-
## 最近更新
79+
## 📝 最近更新
6780

68-
- 2024-11-23
69-
- 修复重复点击生成按钮时,可能导致无法访问短链的问题
81+
### 2024-11-23
82+
- 修复重复点击生成按钮时,可能导致无法访问短链的问题
7083

71-
[查看更新日志](/docs/update-log.md)
84+
[查看完整更新日志](/docs/update-log.md)
7285

73-
## 项目结构
86+
## 🔧 项目结构
7487

7588
```
7689
.
7790
├── index.js # 主要的服务器逻辑,处理请求路由
7891
├── BaseConfigBuilder.js # 构建基础配置
7992
├── SingboxConfigBuilder.js # 构建 Sing-Box 配置
8093
├── ClashConfigBuilder.js # 构建 Clash 配置
81-
├── ProxyParsers.js # 解析各种代理协议的 URL
82-
├── utils.js # 提供各种实用函数
83-
├── htmlBuilder.js # 生成 Web 界面
84-
├── style.js # 生成 Web 界面的 CSS
85-
├── config.js # 保存配置信息
94+
├── ProxyParsers.js # 解析各种代理协议的 URL
95+
├── utils.js # 提供各种实用函数
96+
├── htmlBuilder.js # 生成 Web 界面
97+
├── style.js # 生成 Web 界面的 CSS
98+
├── config.js # 保存配置信息
8699
└── docs/
87-
├── API-doc.md # API 文档
88-
├── update-log.md # 更新日志
89-
└── FAQ.md # 常见问题解答
100+
├── API-doc.md # API 文档
101+
├── update-log.md # 更新日志
102+
└── FAQ.md # 常见问题解答
90103
```
91104

92-
## 贡献
105+
## 🤝 贡献
93106

94107
欢迎提交 Issues 和 Pull Requests 来改进这个项目。
95108

96-
## 许可证
109+
## 📄 许可证
97110

98-
这个项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。
111+
本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。
99112

100-
## 免责声明
113+
## ⚠️ 免责声明
101114

102115
本项目仅供学习交流使用,请勿用于非法用途。使用本项目所造成的一切后果由使用者自行承担,与开发者无关。
103116

104-
## Star History
117+
## Star History
105118

106119
感谢所有为本项目点亮 Star 的朋友们!🌟
107120

0 commit comments

Comments
 (0)