Skip to content

Commit

Permalink
chore: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
7Sageer authored Nov 30, 2024
1 parent 99e5bcd commit 7e8de92
Showing 1 changed file with 73 additions and 60 deletions.
133 changes: 73 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,107 +1,120 @@
<div align="center">
<h1>
<b>Sublink Worker</b>
</h1>
<h1><b>Sublink Worker</b></h1>
<h5><i>Serverless 自部署订阅转换工具最佳实践</i></h5>

<a href="https://trendshift.io/repositories/12291" target="_blank">
<img src="https://trendshift.io/api/badge/repositories/12291" alt="7Sageer%2Fsublink-worker | Trendshift" width="250" height="55"/>
</a>

<p>
<a href="https://sublink-worker.sageer.me">https://sublink-worker.sageer.me</a>
</p>
</div>

## ✨ 功能特点

<div align="center">
<h5>
<i>Serverless 自部署订阅转换工具最佳实践</i>
</h5>
</div>

<div align="center">
<href>
https://sublink-worker.sageer.me
</href>
</div>

## 功能特点
### 支持协议
- ShadowSocks
- VMess
- VLESS
- Hysteria2
- Trojan
- TUIC

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

## 部署
### 客户端支持
- Sing-Box
- Clash
- Xray/V2Ray

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

## 🚀 部署指南

### 推荐:自动部署
[![Deploy to Cloudflare Workers](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/7Sageer/sublink-worker)

### 手动部署
1. 克隆项目仓库:
```bash
git clone https://github.com/7Sageer/sublink-worker.git
```
2. 安装依赖:
```bash
npm install
```
3. 配置 Cloudflare 账户凭证
4. 使用 Wrangler 部署:
```bash
wrangler deploy
```

### 新手指南
- [视频教程1](https://www.youtube.com/watch?v=ZTgDm4qReyA)
- [视频教程2](https://www.youtube.com/watch?v=7abmWqCXPR8)

- 克隆项目仓库:`git clone https://github.com/7Sageer/sublink-worker.git`
- 安装依赖:`npm install`
- 配置 Cloudflare 账户凭证
- 使用 Wrangler 部署:`wrangler deploy`

### 新手?
#### [视频教程1](https://www.youtube.com/watch?v=ZTgDm4qReyA)
#### [视频教程2](https://www.youtube.com/watch?v=7abmWqCXPR8)
> 💡 这些是由社区成员制作的教程视频,详细的讲解可以让你快速上手。但是部分内容可能与我们的见解不同,也可能与最新版本存在差异,建议同时参考[官方文档](/docs)
#### [官方FAQ](/docs/FAQ.md)
## API 文档
- [官方FAQ](/docs/FAQ.md)

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

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

- `/singbox`:生成 Sing-Box 配置
- `/clash`:生成 Clash 配置
- `/xray`:生成 Xray 配置
- `/shorten`:生成短链接
### 主要端点
- `/singbox` - 生成 Sing-Box 配置
- `/clash` - 生成 Clash 配置
- `/xray` - 生成 Xray 配置
- `/shorten` - 生成短链接

## 最近更新
## 📝 最近更新

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

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

## 项目结构
## 🔧 项目结构

```
.
├── index.js # 主要的服务器逻辑,处理请求路由
├── BaseConfigBuilder.js # 构建基础配置
├── SingboxConfigBuilder.js # 构建 Sing-Box 配置
├── ClashConfigBuilder.js # 构建 Clash 配置
├── ProxyParsers.js # 解析各种代理协议的 URL
├── utils.js # 提供各种实用函数
├── htmlBuilder.js # 生成 Web 界面
├── style.js # 生成 Web 界面的 CSS
├── config.js # 保存配置信息
├── ProxyParsers.js # 解析各种代理协议的 URL
├── utils.js # 提供各种实用函数
├── htmlBuilder.js # 生成 Web 界面
├── style.js # 生成 Web 界面的 CSS
├── config.js # 保存配置信息
└── docs/
├── API-doc.md # API 文档
├── update-log.md # 更新日志
└── FAQ.md # 常见问题解答
├── API-doc.md # API 文档
├── update-log.md # 更新日志
└── FAQ.md # 常见问题解答
```

## 贡献
## 🤝 贡献

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

## 许可证
## 📄 许可证

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

## 免责声明
## ⚠️ 免责声明

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

## Star History
## Star History

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

Expand Down

0 comments on commit 7e8de92

Please sign in to comment.