PicList
-
强大的云存储与图床管理工具
+
Powerful cloud storage and image hosting management tool
@@ -13,134 +13,133 @@
-
+
-简体中文 | [English](https://github.com/Kuingsmile/PicList/blob/dev/README_en.md)
+[简体中文](https://github.com/Kuingsmile/PicList/blob/dev/README_cn.md) | English
-## 📑 目录
+## 📑 Table of Contents
-- [📑 目录](#-目录)
-- [简介](#简介)
-- [官方网址](#官方网址)
-- [如何从PicGo迁移](#如何从picgo迁移)
+- [📑 Table of Contents](#-table-of-contents)
+- [Introduction](#introduction)
+- [Official Website](#official-website)
+- [How to Migrate from PicGo](#how-to-migrate-from-picgo)
- [PicList-Core](#piclist-core)
-- [特色功能](#特色功能)
-- [如何使用](#如何使用)
- - [如何在VSCode中使用](#如何在vscode中使用)
- - [如何在Typora中使用](#如何在typora中使用)
- - [**1.6.0版本及以上**](#160版本及以上)
- - [**1.6.0版本以下**](#160版本以下)
- - [如何在Obsidian中使用](#如何在obsidian中使用)
- - [如何在Docker中使用](#如何在docker中使用)
- - [使用docker run命令](#使用docker-run命令)
- - [使用docker-compose](#使用docker-compose)
-- [已支持平台](#已支持平台)
-- [下载安装](#下载安装)
- - [直接下载](#直接下载)
- - [Scoop（Windows）](#scoopwindows)
+- [Key Features](#key-features)
+- [Integration Guides](#integration-guides)
+ - [VSCode Integration](#vscode-integration)
+ - [Typora Integration](#typora-integration)
+ - [**Version 1.6.0-dev and above**](#version-160-dev-and-above)
+ - [**Version \< 1.6.0-dev**](#version--160-dev)
+ - [Obsidian Integration](#obsidian-integration)
+ - [Docker Integration](#docker-integration)
+ - [Using docker run](#using-docker-run)
+ - [Using docker-compose](#using-docker-compose)
+- [Supported Platforms](#supported-platforms)
+- [Download and Install](#download-and-install)
+ - [Direct Download](#direct-download)
+ - [Scoop (Windows)](#scoop-windows)
- [Winget (Windows)](#winget-windows)
- - [Homebrew（macOS）](#homebrewmacos)
- - [系统版本要求](#系统版本要求)
+ - [Homebrew (macOS)](#homebrew-macos)
+ - [OS Requirements](#os-requirements)
- [Windows](#windows)
- [macOS](#macos)
- [Linux](#linux)
-- [应用截图](#应用截图)
-- [开发说明](#开发说明)
- - [前提条件](#前提条件)
- - [开始开发](#开始开发)
- - [开发模式](#开发模式)
- - [生产构建](#生产构建)
-- [其它相关](#其它相关)
+- [Screenshots](#screenshots)
+- [Development](#development)
+ - [Prerequisites](#prerequisites)
+ - [Getting Started](#getting-started)
+ - [Development Mode](#development-mode)
+ - [Production Build](#production-build)
+- [Related Projects](#related-projects)
- [License](#license)
- [Star Me](#star-me)
-## 简介
+## Introduction
-PicList是一款高效的云存储和图床平台管理工具，基于PicGo深度二次开发，提供完整的图床功能和全面的云存储管理能力，主要特点包括：
+PicList is an efficient cloud storage and image hosting management tool built upon PicGo with extensive enhancements. It combines complete image hosting capabilities with comprehensive cloud storage management features, offering:
-- 完整保留PicGo所有功能，兼容大部分PicGo插件
-- 扩展了内置图床平台，如WebDav、本地图床和SFTP等
-- 支持配置文件和相册数据库的云端同步(WebDAV/GitHub/Gitee/Gitea)
-- 相册支持同步云端删除文件
-- 全面的云存储管理功能，包括文件操作、搜索和预览
-- 内置图像处理工具，如水印、压缩、缩放、旋转和格式转换
+- All original PicGo functionality plus compatibility with most PicGo plugins
+- Extended built-in image hosting platforms (WebDav, local hosting, SFTP, etc.)
+- Configuration and album database cloud synchronization (WebDAV/GitHub/Gitee/Gitea)
+- Cloud-synchronized file deletion in album view
+- Comprehensive cloud storage management with file operations, search, and previews
+- Built-in image processing tools (watermarks, compression, scaling, rotation, format conversion)
-## 官方网址
+## Official Website
-请访问 [PicList官网 piclist.cn](https://piclist.cn) 获取更多信息。
+Please visit the [PicList official website piclist.cn](https://piclist.cn) for more information.
-此外，你也可以访问[DeepWiki of PicList](https://deepwiki.com/Kuingsmile/PicList)了解更多关于项目架构和开发的内容。
+You can also visit the [DeepWiki of PicList](https://deepwiki.com/Kuingsmile/PicList) to learn more about the project architecture and development.
-## 如何从PicGo迁移
+## How to Migrate from PicGo
-PicList `V1.5.0`以上版本提供 `一键迁移`功能，进入 `设置`页面，然后在 `从PicGo迁移`选项点击右侧按钮即可，迁移后请重启应用生效。
+PicList `V1.5.0` and above provide a `one-click migration` function. Enter the `Settings` page, click the button next to `Migrate from PicGo`, then restart the application for changes to take effect.
## PicList-Core
-PicList的内核使用[PicList-core](https://github.com/Kuingsmile/PicList-Core)，这是基于原版PicGo-Core修改的版本，具有以下增强功能：
+PicList uses a modified version of PicGo-Core called [PicList-core](https://github.com/Kuingsmile/PicList-Core), adapted for cloud deletion and extended with features like:
-- 水印添加
-- 图片压缩、缩放、旋转和格式转换
-- CLI命令行支持
-- 通过`picgo-server`命令启动上传服务器
+- Watermark addition
+- Image compression, scaling, rotation, and format conversion
+- CLI command support
+- Built-in upload server via `picgo-server` command
-如果您希望单独使用PicList-core，请访问[GitHub仓库](https://github.com/Kuingsmile/PicList-Core)或[npm包](https://www.npmjs.com/package/piclist)。
+To use PicList-core separately, visit [GitHub repo](https://github.com/Kuingsmile/PicList-Core) or the [npm package](https://www.npmjs.com/package/piclist).
-## 特色功能
+## Key Features
-- **完全兼容性**：适用于Typora、Obsidian和大多数PicGo插件
-- **扩展平台支持**：新增WebDav、兰空图床、本地图床、SFTP等，原内置imgur图床额外支持账号登录上传
-- **云端同步相册**：支持同步删除云端图片，兼容所有内置图床和多个插件
-- **高级相册功能**：高级搜索、排序和批量URL修改
-- **内置图像工具**：水印添加、图片压缩、图片缩放、图片旋转和格式转换，支持高级重命名
-- **表单上传**：支持多电脑共享使用
-- **配置同步**：支持配置和相册数据库同步至WebDAV/GitHub/Gitee/Gitea仓库
-- **云存储管理**：云端目录查看、文件搜索、批量操作等功能
-- **多格式预览**：支持预览图片、视频、文本和Markdown文件（查看[支持的文件格式列表](https://github.com/Kuingsmile/PicList/blob/dev/supported_format.md)）
-- **批量操作**：支持使用正则表达式批量重命名云端文件
-- **链接分享**：为私有存储桶生成预签名链接
-- **易用性改进**：软件自动更新、多种启动模式、界面优化等
+- **Complete Compatibility**: Works with Typora, Obsidian, and most PicGo plugins
+- **Extended Platform Support**: Added WebDav, Lsky Pro, local hosting, SFTP, and account-based Imgur uploads
+- **Cloud-Sync Album**: Delete images from storage alongside local entries
+- **Advanced Album Features**: Search, sort, and batch URL modification
+- **Built-in Image Tools**: Add watermarks, compress, scale, rotate, and convert formats
+- **Form Upload**: Share across multiple computers
+- **Config Synchronization**: Save settings and album database to WebDAV/GitHub/Gitee/Gitea repositories
+- **Cloud Management**: Browse directories, search files, batch operations, and more
+- **Multi-format Previews**: View images, videos, text files, and Markdown files (see [supported formats](https://github.com/Kuingsmile/PicList/blob/dev/supported_format.md))
+- **Batch Operations**: Rename cloud files with regular expressions
+- **Link Sharing**: Generate pre-signed URLs for private storage buckets
+- **Usability Improvements**: Auto-updates, multiple startup modes, UI enhancements, and more
-## 如何使用
+## Integration Guides
-### 如何在VSCode中使用
+### VSCode Integration
-安装[VS-PicList](https://marketplace.visualstudio.com/items?itemName=Kuingsmile.vs-piclist)插件，与vs-picgo插件相比，该插件直接依赖于PicList桌面端软件，支持多种上传方式和直接在VSCode中进行云端删除等功能。
+Install the [VS-PicList](https://marketplace.visualstudio.com/items?itemName=Kuingsmile.vs-piclist) plugin, which integrates directly with PicList desktop software and supports a variety of uploads and cloud deletion operations in VSCode.
-### 如何在Typora中使用
+### Typora Integration
-#### **1.6.0版本及以上**
+#### **Version 1.6.0-dev and above**
-**Typora 1.6.0-dev以及以上版本已原生支持PicList**。在1.10.6版本以下中，需要将Typora的语言设置为中文。
+**Typora 1.6.0-dev and later versions natively support PicList.** For versions below 1.10.6, set Typora's language to Chinese.
-如果您使用的是1.8.0以下版本的Typora，需要同时设置PicList和PicGo(app)上传服务的路径为PicList的安装路径。
+If your Typora version is below 1.8.0, set both the PicList and PicGo (app) upload service paths to your PicList installation path.
-[Typora下载链接](https://typora.io/releases/all)
+[Typora download link](https://typora.io/releases/all)
-#### **1.6.0版本以下**
+#### **Version < 1.6.0-dev**
-Windows系统：
+For Windows, in Typora settings:
-1. 进入Typora设置页面，选择"图像"
-2. 将上传服务设置为`PicGo(app)`
-3. 在`PicGo路径`中填写PicList的安装路径
+1. Set upload service to `PicGo(app)`
+2. Set `PicGo path` to your PicList installation path
-
+
-或者，您也可以使用`npm install piclist`命令安装PicList-core，然后将上传服务设置为`PicGo-Core(command line)`。
+Alternatively, install PicList-core with `npm install piclist` and set the upload service to `PicGo-Core (command line)`.
-### 如何在Obsidian中使用
+### Obsidian Integration
-1. 在社区插件中搜索安装`Image auto upload Plugin`
-2. 进入插件设置页面，将默认上传器修改为`PicGo(app)`
-3. 设置`PicGo server`为`http://127.0.0.1:36677/upload`
-4. 如需启用云端删除功能，请在删除接口中填入`http://127.0.0.1:36677/delete`
+1. Install the "Image auto upload Plugin" from community plugins
+2. Set the default uploader to PicGo(app)
+3. Configure PicGo server as `http://127.0.0.1:36677/upload`
+4. For cloud deletion support, set the deletion interface to `http://127.0.0.1:36677/delete`
-
+
-### 如何在Docker中使用
+### Docker Integration
-#### 使用docker run命令
+#### Using docker run
```bash
docker pull kuingsmile/piclist:latest
@@ -153,9 +152,9 @@ docker run -d \
node /usr/local/bin/picgo-server -k piclist123456
```
-请将`./piclist`修改为您的配置文件`config.json`所在路径，将`piclist123456`修改为您自己的密钥。
+Change `./piclist` to your config directory path and `piclist123456` to your preferred secret key.
-#### 使用docker-compose
+#### Using docker-compose
```yaml
version: '3.3'
@@ -172,43 +171,43 @@ services:
command: node /usr/local/bin/picgo-server -k piclist123456
```
-使用`docker-compose up -d`命令启动。
+Run with `docker-compose up -d`
-## 已支持平台
+## Supported Platforms
-| 平台 | 相册云删除 | 云存储管理 |
-| :------------: | :--------: | :--------: |
-| 内置AList | ✔️ | ✔️ |
-| SM.MS | ✔️ | ✔️ |
-| Github | ✔️ | ✔️ |
-| Imgur | ✔️ | ✔️ |
-| 腾讯COS V5 | ✔️ | ✔️ |
-| 阿里云OSS | ✔️ | ✔️ |
-| 又拍云 | ✔️ | ✔️ |
-| 七牛云 | ✔️ | ✔️ |
-| S3 API兼容平台 | ✔️ | ✔️ |
-| WebDAV | ✔️ | ✔️ |
-| 本地文件夹 | ✔️ | ✔️ |
-| 内置SFTP | ✔️ | ✔️ |
-| 多吉云 | ✔️ | ✔️ |
-| PicList(套娃) | ✔️ | ✔️ |
-| 兰空图床 | ✔️ | ✔️ |
-| 自定义图床 | x | x |
+| Platform | Album Cloud Deletion | Cloud Storage Management |
+| :------------------------: | :------------------: | :----------------------: |
+| Built-in AList | ✔️ | ✔️ |
+| SM.MS | ✔️ | ✔️ |
+| Github | ✔️ | ✔️ |
+| Imgur | ✔️ | ✔️ |
+| Tencent COS V5 | ✔️ | ✔️ |
+| Aliyun OSS | ✔️ | ✔️ |
+| Upyun | ✔️ | ✔️ |
+| Qiniu | ✔️ | ✔️ |
+| S3 API compatible platform | ✔️ | ✔️ |
+| WebDAV | ✔️ | ✔️ |
+| Local | ✔️ | ✔️ |
+| Built-in SFTP | ✔️ | ✔️ |
+| Doge Cloud | ✔️ | ✔️ |
+| PicList(Lasso-Doll) | ✔️ | ✔️ |
+| Lsky Pro | ✔️ | ✔️ |
+| Custom API platform | × | × |
-**支持云删除功能的插件：**
+**Supported Plugins with Cloud Deletion:**
- [picgo-plugin-s3](https://github.com/wayjam/picgo-plugin-s3)
- [picgo-plugin-alist](https://github.com/jinzhi0123/picgo-plugin-alist)
- [picgo-plugin-huawei-uploader](https://github.com/YunfengGao/picgo-plugin-huawei-uploader)
- [picgo-plugin-dogecloud](https://github.com/w4j1e/picgo-plugin-dogecloud)
-## 下载安装
+## Download and Install
-### 直接下载
+### Direct Download
-[下载最新版本](https://github.com/Kuingsmile/PicList/releases/latest)
+[Download the latest release](https://github.com/Kuingsmile/PicList/releases/latest)
-### Scoop（Windows）
+### Scoop (Windows)
```bash
scoop bucket add lemon https://github.com/hoilc/scoop-lemon
@@ -221,81 +220,81 @@ scoop install lemon/piclist
winget install Kuingsmile.PicList
```
-### Homebrew（macOS）
+### Homebrew (macOS)
```bash
-# 安装
+# Install
brew install piclist --cask
-# 卸载
+# Uninstall
brew uninstall piclist
```
-### 系统版本要求
+### OS Requirements
#### Windows
-- **支持的版本**: Windows 10及以上版本
-- **架构**: `ia32` (x86), `x64` (amd64), `arm64`
+- **Supported Versions**: Windows 10 and later
+- **Architectures**: `ia32` (x86), `x64` (amd64), `arm64`
#### macOS
-- **支持的版本**: macOS Big Sur (11)及以上
-- **架构**: Intel (x64)和Apple Silicon (arm64)
+- **Supported Versions**: macOS Big Sur (11) and later
+- **Architectures**: Intel (x64) and Apple Silicon (arm64)
#### Linux
-- **包括不限于**:
- - Ubuntu 18.04及更新版本
- - Fedora 32及更新版本
- - Debian 10及更新版本
+- **Supported Versions**:
+ - Ubuntu 18.04 and later
+ - Fedora 32 and later
+ - Debian 10 and later
-## 应用截图
+## Screenshots
-
-
-
-
-
-
+
+
+
+
+
+
-## 开发说明
+## Development
-### 前提条件
+### Prerequisites
-1. 需要Node.js 20+ 和 Git
-2. 了解npm相关知识
-3. Mac需要Xcode环境，Windows需要Visual Studio环境
+1. Node.js 20 + and Git
+2. Knowledge of npm
+3. Xcode for Mac or Visual Studio for Windows
-### 开始开发
+### Getting Started
```bash
git clone https://github.com/Kuingsmile/PicList.git
cd PicList
-yarn # 不要使用npm install
+yarn # Do not use npm install
```
-如需贡献代码，请参考[贡献指南](https://github.com/Kuingsmile/PicList/blob/dev/CONTRIBUTING.md)。
+To contribute, see the [contribution guide](https://github.com/Kuingsmile/PicList/blob/dev/CONTRIBUTING_EN.md).
-### 开发模式
+### Development Mode
```bash
yarn run dev
```
-开发模式具有热重载特性，但可能不稳定。如果进程崩溃，请用`Ctrl+C`退出并重新启动。
+Development mode has hot-reload but may be unstable. If the process crashes, exit with `Ctrl+C` and restart.
-注意：开发模式运行后，PicList的应用图标会出现在任务栏/系统托盘中。
+Note: The PicList application icon will appear in your taskbar/system tray while in development mode.
-### 生产构建
+### Production Build
```bash
yarn run build
```
-构建成功后，安装文件将出现在`dist_electron`目录中。
+The built installer will be available in the `dist_electron` directory.
-如果遇到网络问题导致electron-builder下载失败，可以设置镜像源：
+For network issues with electron-builder, set the mirror:
**Linux/macOS:**
@@ -309,19 +308,19 @@ export ELECTRON_MIRROR="https://npmmirror.com/mirrors/electron/"
set ELECTRON_MIRROR=https://npmmirror.com/mirrors/electron/
```
-## 其它相关
+## Related Projects
-- [PicList-Core](https://github.com/Kuingsmile/PicList-Core)：基于PicGo-Core的核心库，用于CLI操作和项目开发
-- [PicHoro](https://github.com/Kuingsmile/PicHoro)：配合PicList使用的手机APP
-- [VS-PicList](https://github.com/Kuingsmile/vs-PicList/)：配合PicList使用的VSCode插件
+- [PicList-Core](https://github.com/Kuingsmile/PicList-Core): Core library based on PicGo-Core for CLI and development
+- [PicHoro](https://github.com/Kuingsmile/PicHoro): Mobile app companion for PicList
+- [VS-PicList](https://github.com/Kuingsmile/vs-PicList/): VSCode plugin for PicList
## License
-本项目基于MIT协议开源，欢迎大家使用和贡献代码，感谢原作者Molunerfinn的开源精神。
+This project is open source under the MIT license.
[MIT](https://opensource.org/licenses/MIT)
-Copyright (c) 2017-present Molunerfinn
+Copyright (c) 2017-present Molunerfinn
Copyright (c) 2023-present Kuingsmile
## Star Me
diff --git a/README_cn.md b/README_cn.md
new file mode 100644
index 00000000..486d5ae0
--- /dev/null
+++ b/README_cn.md
@@ -0,0 +1,331 @@
+
+ 
+