Skip to content

Commit 604d964

Browse files
committed
chore(docs): Update some descriptions
1 parent 095cea9 commit 604d964

File tree

3 files changed

+13
-47
lines changed

3 files changed

+13
-47
lines changed

README.md

Lines changed: 9 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,12 @@
66

77
- 在上传图片前自动备份到本地目录
88
- 支持复制或剪切操作
9-
- 使用与 PicList 相同的重命名规则,确保本地备份与云端文件名一致性
109
- 详细的日志记录系统
11-
- 适配阿里云等对中文文件名进行 URL 编码的图床服务
12-
- 完全不干扰 PicGo 原有的上传流程
10+
- 不干扰 PicList-Core 原有的上传流程
1311

1412
## 安装
1513

16-
### 方式1:通过 npm 安装(推荐)
14+
### 通过 npm 安装
1715

1816
```bash
1917
# 全局安装 picgo
@@ -23,17 +21,16 @@ npm install picgo -g
2321
picgo install @rerokutosei/picgo-plugin-localbackup
2422
```
2523

26-
### 方式2:手动安装
27-
28-
1. 克隆本仓库
29-
2. 在仓库目录下执行:
24+
## 配置插件
3025
```bash
31-
npm install
32-
npm run build
26+
# 配置插件
27+
picgo config plugin @rerokutosei/picgo-plugin-localbackup
28+
29+
# 启用插件
30+
picgo use plugins @rerokutosei/picgo-plugin-localbackup
3331
```
34-
3. 将生成的 `dist` 目录复制到 PicGo 的插件目录中
3532

36-
## 配置
33+
## 配置项
3734

3835
插件提供以下配置项:
3936

@@ -47,20 +44,6 @@ npm run build
4744
- copy: 复制原文件到备份目录(保留原文件)
4845
- cut: 移动原文件到备份目录(删除原文件)
4946

50-
### 重要说明
51-
52-
- 本插件现在使用 PicGo 的重命名系统,不再提供单独的重命名功能
53-
- 建议在 PicGo 配置中设置重命名模板为 `{uuid}`,这样可以:
54-
1. 避免文件名冲突
55-
2. 确保本地备份与云端文件保持一致性
56-
3. 便于日后文件匹配和管理
57-
58-
### 示例配置:
59-
60-
```bash
61-
picgo set plugin @rerokutosei/picgo-plugin-localbackup
62-
```
63-
6447
## 日志系统
6548

6649
插件会在备份目录的 `logs` 子目录下生成日期格式的日志文件,记录所有备份操作:
@@ -78,23 +61,6 @@ picgo set plugin @rerokutosei/picgo-plugin-localbackup
7861
2025-06-04T10:15:30.123Z Copied: C:\Users\Example\image.jpg -> D:\backup\c9549605-6017-454c-9743-34d40d158121.jpg
7962
```
8063

81-
## 最佳实践
82-
83-
1. **备份目录设置**
84-
- 建议使用绝对路径,例如:`D:\Pictures\Backup`
85-
- 确保目录具有写入权限
86-
- 避免使用系统关键目录
87-
88-
2. **PicGo 配置建议**
89-
- 设置 PicGo 的重命名格式为 `{uuid}`
90-
- 启用图片压缩可以节省备份空间
91-
- 推荐开启 webp 转换以获得更好的压缩率
92-
93-
3. **使用场景**
94-
- 图床迁移:备份可用于快速恢复或迁移
95-
- 防止数据丢失:本地备份可作为云端数据的保障
96-
- 批量处理:可以通过本地备份批量处理图片
97-
9864
## 开发
9965

10066
```bash

package-lock.json

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
-4.24 KB
Binary file not shown.

0 commit comments

Comments
 (0)