Skip to content

Commit c9efa9c

Browse files
committed
docs: update README.md with quick start guide and deployment button; add legacy Shadowsocks URL support to update log
1 parent 3a2a8d2 commit c9efa9c

File tree

2 files changed

+23
-31
lines changed

2 files changed

+23
-31
lines changed

README.md

+19-31
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,25 @@
99
<p>
1010
<a href="https://sublink-worker.sageer.me">https://sublink-worker.sageer.me</a>
1111
</p>
12+
13+
<p>
14+
<a href="https://deploy.workers.cloudflare.com/?url=https://github.com/7Sageer/sublink-worker">
15+
<img src="https://deploy.workers.cloudflare.com/button" alt="Deploy to Cloudflare Workers"/>
16+
</a>
17+
</p>
1218
</div>
1319

20+
## 🚀 快速开始
21+
22+
### 一键部署
23+
只需点击上方按钮,即可快速部署您的专属订阅转换服务。
24+
25+
### 新手指南
26+
- [视频教程1](https://www.youtube.com/watch?v=ZTgDm4qReyA)
27+
- [视频教程2](https://www.youtube.com/watch?v=7abmWqCXPR8)
28+
29+
> 💡 这些是由社区成员制作的教程视频,详细的讲解可以让你快速上手。但是部分内容可能与我们的见解不同,也可能与最新版本存在差异,建议同时参考[官方文档](/docs)
30+
1431
## ✨ 功能特点
1532

1633
### 支持协议
@@ -38,34 +55,6 @@
3855
- 提供多种预定义规则集
3956
- 可自建关于 geo-site、geo-ip、ip-cidr 和 domain-suffix 的自定义策略组
4057

41-
## 🚀 部署指南
42-
43-
### 推荐:自动部署
44-
[![Deploy to Cloudflare Workers](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/7Sageer/sublink-worker)
45-
46-
### 手动部署
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)
64-
65-
> 💡 这些是由社区成员制作的教程视频,详细的讲解可以让你快速上手。但是部分内容可能与我们的见解不同,也可能与最新版本存在差异,建议同时参考[官方文档](/docs)
66-
67-
- [官方FAQ](/docs/FAQ.md)
68-
6958
## 📖 API 文档
7059

7160
详细的 API 文档请参考 [API-doc.md](/docs/API-doc.md)
@@ -78,9 +67,8 @@
7867

7968
## 📝 最近更新
8069

81-
### 2024-11-23
82-
- 修复重复点击生成按钮时,可能导致无法访问短链的问题
83-
70+
### 2024-11-30
71+
- 添加对 Shadowsocks 旧式 URL 的支持
8472
[查看完整更新日志](/docs/update-log.md)
8573

8674
## 🔧 项目结构

docs/update-log.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# 更新日志
22

3+
## 2024-11-30
4+
5+
- 添加对 Shadowsocks 旧式 URL 的支持
6+
37
## 2024-11-23
48

59
- Bug修复:

0 commit comments

Comments
 (0)