📝 Docs: update README

This commit is contained in:
萌萌哒赫萝
2023-04-07 10:55:27 +08:00
parent e06dafb835
commit 4770fcd49d
2 changed files with 44 additions and 46 deletions

View File

@@ -1,4 +1,3 @@
<div align="center">
<img src="https://imgx.horosama.com/admin_uploads/2022/10/2022_10_05_633d79e401694.png" alt="">
<h1>PicList</h1>
@@ -15,11 +14,11 @@
简体中文 | [English](https://github.com/Kuingsmile/PicList/blob/dev/README_en.md)
PicList是一款云存储/图床平台管理和文件上传工具基于PicGo的进行了深度二次开发保留了PicGo的所有功能的同时为相册添加了同步云端删除功能同时增加了完整的云存储管理功能包括云端目录查看、文件搜索、批量上传下载和删除文件复制多种格式文件链接和图片/markdown/文本/视频预览等。
PicList是一款云存储/图床平台管理和文件上传工具基于PicGo的进行了深度二次开发保留了PicGo的所有功能的同时为相册添加了同步云端删除功能同时增加了完整的云存储管理功能包括云端目录查看、文件搜索、批量上传下载和删除文件复制多种格式文件链接和图片/markdown/文本/视频预览等,另外还有更加强大的相册和多项功能新增或优化
## 如何从PicGo迁移
PicList `V1.5.0`以上版本提供`一键迁移`功能,进入`设置`页面,然后在`从PicGo迁移`选项点击右侧按钮即可,迁移后请重启应用生效。
PicList `V1.5.0`以上版本提供 `一键迁移`功能,进入 `设置`页面,然后在 `从PicGo迁移`选项点击右侧按钮即可,迁移后请重启应用生效。
## PicList-Core
@@ -30,7 +29,7 @@ PicList的内核使用的是原版PicGo-Core基础上修改的[PicList-core](htt
## 特色功能
- 保留了PicGo的所有功能兼容已有的PicGo插件系统包括和typora、obsidian等的搭配
- 相册中可同步删除云端图片
- 相册中可同步删除云端图片同时新增了高级搜索和排序批量修改URL等功能
- 内置水印添加、图片压缩、图片缩放、图片旋转和图片格式转换等功能支持自定义配置且可以通过CLI命令行调用
- 支持管理所有图床,可以在线进行云端目录查看、文件搜索、批量上传、批量下载、删除文件等
- 支持预览多种格式的文件包括图片、视频、纯文本文件和markdown文件等具体支持的格式请参考[支持的文件格式列表](https://github.com/Kuingsmile/PicList/blob/dev/supported_format.md)
@@ -44,15 +43,15 @@ PicList的内核使用的是原版PicGo-Core基础上修改的[PicList-core](htt
Windows:
进入Typora设置界面选择图像将上传服务设置为`PicGo(app)`,然后在`PicGo路径`中填写PicList的安装路径如下图所示
进入Typora设置界面选择图像将上传服务设置为 `PicGo(app)`,然后在 `PicGo路径`中填写PicList的安装路径如下图所示
![image](https://user-images.githubusercontent.com/96409857/226522101-b3531b7b-534c-4149-b527-8738d4ebb041.png)
或者,您也可以使用`npm install piclist`命令安装PicList-core然后上传服务设置为`PicGo-Core(command line)`
或者,您也可以使用 `npm install piclist`命令安装PicList-core然后上传服务设置为 `PicGo-Core(command line)`
MacOS:
进入Typora设置界面选择图像将上传服务设置为`Custom Command`,然后在`Command`中填写`/Applications/PicList.app/Contents/MacOS/PicList upload`,如下图所示:
进入Typora设置界面选择图像将上传服务设置为 `Custom Command`,然后在 `Command`中填写 `/Applications/PicList.app/Contents/MacOS/PicList upload`,如下图所示:
![image](https://user-images.githubusercontent.com/96409857/226645570-4c6e06a5-5bd9-40c3-a21d-8446c66325e3.png)
@@ -60,27 +59,27 @@ MacOS:
### 如何在Obsidian中使用
在社区插件中搜索安装`Image auto upload Plugin`,然后进入插件设置页面,修改默认上传器为`PicGo(app)`,设置`PicGo server``http://127.0.0.1:36677/upload`即可,如下图所示:
在社区插件中搜索安装 `Image auto upload Plugin`,然后进入插件设置页面,修改默认上传器为 `PicGo(app)`,设置 `PicGo server` `http://127.0.0.1:36677/upload`即可,如下图所示:
![image](https://user-images.githubusercontent.com/96409857/226522718-8378c480-9fb4-4785-87e1-d59808862016.png)
## 已支持平台
| 平台 | 相册云删除 | 云存储管理 |
| :------------: | :----------------: | :----------------: |
| SM.MS | :heavy_check_mark: | :heavy_check_mark: |
| Github | :heavy_check_mark: | :heavy_check_mark: |
| Imgur | :heavy_check_mark: | :heavy_check_mark: |
| 腾讯COS V5 | :heavy_check_mark: | :heavy_check_mark: |
| 阿里云OSS | :heavy_check_mark: | :heavy_check_mark: |
| 又拍云 | :heavy_check_mark: | :heavy_check_mark: |
| 七牛云 | :heavy_check_mark: | :heavy_check_mark: |
| S3 API兼容平台 | :heavy_check_mark: | :heavy_check_mark: |
| WebDAV | :heavy_check_mark: | :heavy_check_mark: |
| 平台 | 相册云删除 | 云存储管理 |
| :------------: | :--------: | :--------: |
| SM.MS | ✔️ | ✔️ |
| Github | ✔️ | ✔️ |
| Imgur | ✔️ | ✔️ |
| 腾讯COS V5 | ✔️ | ✔️ |
| 阿里云OSS | ✔️ | ✔️ |
| 又拍云 | ✔️ | ✔️ |
| 七牛云 | ✔️ | ✔️ |
| S3 API兼容平台 | ✔️ | ✔️ |
| WebDAV | ✔️ | ✔️ |
| 插件 | 相册云删除 |
| :----------------------------------------------------------: | :----------------: |
| [picgo-plugin-s3](https://github.com/wayjam/picgo-plugin-s3) | :heavy_check_mark: |
| 插件 | 相册云删除 |
| :-------------------------------------------------------: | :--------: |
| [picgo-plugin-s3](https://github.com/wayjam/picgo-plugin-s3) | ✔️ |
## 下载安装
@@ -96,7 +95,7 @@ MacOS:
由于Mac App Store的沙盒机制导致多项功能无法正常使用因此不再支持Mac App Store的安装方式。
如果您已经通过Mac App Store购买了PicList请添加我的微信`pku_sq_ma`,我会为您退费。
如果您已经通过Mac App Store购买了PicList请添加我的微信 `pku_sq_ma`,我会为您退费。
再次感谢您对PicList的支持。
@@ -118,8 +117,8 @@ MacOS:
1. 你需要有 Node、Git 环境,了解 npm 的相关知识。
2. git clone [https://github.com/Kuingsmile/PicList.git](https://github.com/Kuingsmile/PicList.git) 并进入项目。
`yarn` 下载依赖
注意如果你没有yarn请去 官网 下载安装后再使用。 用 npm install 将导致未知错误!
`yarn` 下载依赖
注意如果你没有yarn请去 官网 下载安装后再使用。 用 npm install 将导致未知错误!
3. Mac 需要有 Xcode 环境Windows 需要有 VS 环境。
4. 如果需要贡献代码,可以参考[贡献指南](https://github.com/Kuingsmile/PicList/blob/dev/CONTRIBUTING.md)。
@@ -152,6 +151,6 @@ MacOS:
[MIT](https://opensource.org/licenses/MIT)
Copyright (c) 2017-present, Molunerfinn
Copyright (c) 2017-present, Molunerfinn
Copyright (c) 2023-present Kuingsmile