Skip to content

Commit ddeccf3

Browse files
committed
docs: update README
1 parent df3e1e5 commit ddeccf3

File tree

6 files changed

+14
-98
lines changed

6 files changed

+14
-98
lines changed

README.md

Lines changed: 7 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -15,64 +15,22 @@
1515
## Features
1616

1717
- 🔽 Instead of browser download manager
18+
- 🖱️ Right-click menu download
1819
- 🔍 Sniff web resources
1920
- ⚙️ Support multiple downloader configurations
2021
- 📦 More..
2122

22-
## Advanced Usage
23+
## Usage
2324

24-
This extension is "**ready to use after download**" and usually requires no worries on your part.
25+
Basicly, this extension is **ready to use**, you don't need to do any settings, just make sure you have installed `Gopeed`.
2526

26-
### Temp disable the extension
27+
### Remote Download
2728

28-
![en_temp_disabled](/_docs/img/tutorial/en_temp_disabled.png)
29+
The extension supports pushing tasks to the `Gopeed server` for downloading. If you have deployed the `web` or `docker` version, you can configure the remote download server through the extension.
2930

30-
### How to customize API
31+
![](/_docs//img/tutorial/en_api.png)
3132

32-
1. Open ext settings
33-
34-
![en_settings](/_docs/img/tutorial/en_settings.png)
35-
36-
2. Edit the API settings (MUST BE SAME AS WHAT YOU'VE SET IN SOFTWARE)
37-
38-
![en_api](/_docs/img/tutorial/en_api.png)
39-
40-
### How to set file types that do not need to be captured
41-
42-
1. Open ext setting page and turn to _Basic Settings_ page.
43-
2. Open and edit the box of the option _File Type Filter_, for example:
44-
45-
- Note: `.tar.gz` would be matched by both `.gz` and `.tar.gz`
46-
47-
```text
48-
.jpg
49-
.jpeg
50-
.png
51-
.tif
52-
.tiff
53-
.webp
54-
.avif
55-
.gif
56-
.pdf
57-
.docx
58-
.doc
59-
.pptx
60-
.ppt
61-
.xlsx
62-
.xls
63-
```
64-
65-
### How to set domains that do not need to be captured
66-
67-
1. Open ext setting page and turn to _Basic Settings_ page.
68-
2. Open and edit the box of the option _Domain Filter_, for example:
69-
70-
- Note: The use of **regular expression** or **wildcard characters** is **not** supported.
71-
72-
```text
73-
changjiang.yuketang.cn
74-
zhihu.com
75-
```
33+
> **Tip**: You can also [enable](https://docs.gopeed.com/zh/dev-api.html#%E5%90%AF%E7%94%A8%E6%8E%A5%E5%8F%A3) Gopeed's TCP protocol as a remote download server, which is suitable for cases where the browser extension does not automatically take over the download, such as the `Linux` version, which is unlikely to be automatically taken over for downloading.
7634
7735
## Build
7836

README_zh-CN.md

Lines changed: 7 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -15,64 +15,22 @@
1515
## 功能
1616

1717
- 🔽 接管浏览器下载
18+
- 🖱️ 右键菜单下载
1819
- 🔍 嗅探网页资源
1920
- ⚙️ 支持多个下载器配置
2021
- 📦 More..
2122

22-
## 进阶教程
23+
## 教程
2324

24-
本扩展**开箱即用**一般无须操心
25+
本扩展**开箱即用**通常不需要您进行任何设置,只要确保安装了`Gopeed`即可。
2526

26-
### 临时禁用扩展
27+
### 远程下载
2728

28-
![zhcn_temp_disabled](/_docs/img/tutorial/zhcn_temp_disabled.png)
29+
扩展支持把任务推送到`Gopeed服务端`进行下载,如果部署的`web`或者`docker`版本,可以通过扩展进行配置远程下载服务器进行下载。
2930

30-
### 如何自定义API接口
31+
![](/_docs//img/tutorial/zhcn_api.png)
3132

32-
1. 打开设置
33-
34-
![zhcn_settings](/_docs/img/tutorial/zhcn_settings.png)
35-
36-
2. 填写接口设置(必须与软件内设置相同)
37-
38-
![zhcn_api](/_docs/img/tutorial/zhcn_api.png)
39-
40-
### 如何屏蔽指定后缀名(扩展名)的文件
41-
42-
1. 打开扩展设置
43-
2. 在“基础设置”页面的“文件类型过滤”栏依次填写您不需要捕获的文件类型名称,例如:
44-
45-
- 注:`.tar.gz` 会被 `.gz``.tar.gz` 匹配
46-
47-
```text
48-
.jpg
49-
.jpeg
50-
.png
51-
.tif
52-
.tiff
53-
.webp
54-
.avif
55-
.gif
56-
.pdf
57-
.docx
58-
.doc
59-
.pptx
60-
.ppt
61-
.xlsx
62-
.xls
63-
```
64-
65-
### 如何屏蔽来自指定域名的文件
66-
67-
1. 打开扩展设置
68-
2. 在“基础设置”页面的“域名过滤”栏依次填写您不需要捕获的网址,例如:
69-
70-
- 注:**不支持通配符**
71-
72-
```text
73-
changjiang.yuketang.cn
74-
zhihu.com
75-
```
33+
> **Tip**: 也可以[开启](https://docs.gopeed.com/zh/dev-api.html#%E5%90%AF%E7%94%A8%E6%8E%A5%E5%8F%A3)Gopeed的TCP协议作为远程下载服务器,适用于浏览器扩展不自动接管的情况,比如`Linux`版本大概率无法被自动接管下载。
7634
7735
## 构建
7836

_docs/img/tutorial/en_settings.png

-107 KB
Binary file not shown.
-107 KB
Binary file not shown.
-97.4 KB
Binary file not shown.
-97.8 KB
Binary file not shown.

0 commit comments

Comments
 (0)