Skip to content

Commit de13df8

Browse files
committed
docs(README): update
1 parent 1a4017a commit de13df8

File tree

2 files changed

+21
-14
lines changed

2 files changed

+21
-14
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ compressor -h
6161
## Full Usage
6262

6363
```
64-
Version: 2.x
64+
Version: 2.3
6565
Usage: compressor [-h] [Options]
6666
6767
Options:
@@ -75,6 +75,8 @@ Options:
7575
Input Path
7676
-j int
7777
Thread Count (default 4)
78+
-log
79+
Save Log as File
7880
-o string
7981
Output Path
8082
-q int
@@ -89,11 +91,13 @@ Modify the file `config.json` directly
8991

9092
# Configuration Description
9193

92-
| Name | Value | Description |
93-
| :----------: | :---------------------------: | :----------------------------------------------------------: |
94-
| thread_count | lower than the number of core | Thread count |
95-
| input_format | "png", "jpg", "jpeg" | Input image format (other formats will be ignored) |
96-
| input_path | D:\\in\\ | Input path, must be a folder (will recursively process all subfolders) |
94+
| Name | Value | Description |
95+
|:------------:|:-----------------------------:|:-------------------------------------------------------------------------------------------------:|
96+
| thread_count | lower than the number of core | Thread count |
97+
| input_format | "png", "jpg", "jpeg" | Input image format (other formats will be ignored) |
98+
| input_path | D:\\in\\ | Input path, can be a file or a folder (will recursively process all subfolders) |
9799
| output_path | D:\\out\\ | Output path, create a new folder under the parent directory of the input folder if not specified |
98-
| quality | 1~100 | Determines the jpeg encoding quality. Default is 90 |
100+
| quality | 1~100 | Determines the jpeg encoding quality. Default is 90 |
101+
| log_to_file | bool | save log to file |
102+
99103

README_zh_CN.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ compressor -h
5959
## 完整用法
6060

6161
```
62-
Version: 2.x
62+
Version: 2.3
6363
Usage: compressor [-h] [Options]
6464
6565
Options:
@@ -73,6 +73,8 @@ Options:
7373
Input Path
7474
-j int
7575
Thread Count (default 4)
76+
-log
77+
Save Log as File
7678
-o string
7779
Output Path
7880
-q int
@@ -85,10 +87,11 @@ Options:
8587

8688
# 配置文件说明
8789

88-
| 名称 | 可选值 | 说明 |
89-
| :----------: | :------------------: | :------------------------------------------------------: |
90-
| thread_count | 小于CPU核心数的两倍 | 线程数 |
91-
| input_format | "png", "jpg", "jpeg" | 输入图片格式(其他格式将被忽略) |
92-
| input_path | D:\\in\\ | 输入路径,必须是文件夹(将递归处理所有子文件夹) |
90+
| 名称 | 可选值 | 说明 |
91+
|:------------:|:--------------------:|:----------------------------:|
92+
| thread_count | 小于CPU核心数的两倍 | 线程数 |
93+
| input_format | "png", "jpg", "jpeg" | 输入图片格式(其他格式将被忽略) |
94+
| input_path | D:\\in\\ | 输入路径,必须是文件夹(将递归处理所有子文件夹) |
9395
| output_path | D:\\out\\ | 输出路径,若不指定,则默认在输入路径父文件夹下新建文件夹 |
94-
| quality | 1~100 | 输出图片质量,推荐 90 |
96+
| quality | 1~100 | 输出图片质量,推荐 90 |
97+
| log_to_file | bool | 保存日志到文件 |

0 commit comments

Comments
 (0)