From 78ba4e44b7f879989110693206a5aad2811500cc Mon Sep 17 00:00:00 2001 From: jigsaw Date: Fri, 8 Apr 2022 20:35:09 +0800 Subject: [PATCH] docs: update README --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index fee97fe..ecd3cbe 100644 --- a/README.md +++ b/README.md @@ -21,26 +21,26 @@ ## Usage ```sh -./simpread-sync +./simpread-sync -c ``` -启动时如果不带参数,配置文件默认为当前工作目录下的 config.json。 - -config.json 默认配置如下,`syncPath` 必须填写,否则无法自动同步。 - -`outputPath` 如果不填写,默认为 `syncPath` 下的 output 文件夹。 +config.json 默认配置如下: ```json { "port": 7026, "syncPath": "", "outputPath": "", - "title": "[简悦] - {{ title }}", "smtpHost": "", - "smtpPort": 0, - "username": "", - "password": "", + "smtpPort": 465, + "smtpUsername": "", + "smtpPassword": "", + "mailTitle": "[简悦] - {{ title }}", "receiverMail": "", "kindleMail": "" } ``` + +`syncPath` 必须填写,否则无法自动同步。 + +`outputPath` 如果不填写,默认为 `syncPath` 下的 output 文件夹。