From db7b419580a075aca23b405f0de97b3a0e9b7837 Mon Sep 17 00:00:00 2001
From: JoeamAmier <yonglelolu@gmail.com>
Date: Wed, 30 Aug 2023 22:59:06 +0800
Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=E9=A1=B9=E7=9B=AE=E8=AF=B4?=
 =?UTF-8?q?=E6=98=8E?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 12 +++++++-----
 main.py   | 12 ++++++------
 2 files changed, 13 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index cbd8e9a..aa0063a 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,10 @@
 <li>发布 EXE 可执行文件，开箱即用</li>
 <li>增加配置文件，编辑文件设置参数</li>
 </ul>
-<h1>⌨️ 代码示例</h1>
+<h1>📖 使用方法</h1>
+<h2>💻 作品下载</h2>
+<p>配置 Python 环境，运行 <code>main.py</code>；运行参数可通过编辑 <code>settings.json</code> 文件进行修改。</p>
+<h2>⌨️ 二次开发</h2>
 <pre>
 # 测试链接
 error_demo = "https://www.xiaohongshu.com/explore/"
@@ -22,7 +25,7 @@ video_demo = "https://www.xiaohongshu.com/explore/64c05652000000000c0378e7"
 # 实例对象
 path = "./"  # 作品下载储存根路径，默认值：当前路径
 folder = "Download"  # 作品下载文件夹名称（自动创建），默认值：Download
-proxies = None  # 代理
+proxies = None  # 网络代理
 timeout = 5  # 网络请求超时限制，默认值：10
 chunk = 1024 * 1024  # 下载文件时，每次从服务器获取的数据块大小，单位字节
 xhs = XHS(
@@ -32,9 +35,8 @@ xhs = XHS(
     timeout=timeout,
     chunk=chunk, )  # 使用自定义参数
 # xhs = XHS()  # 使用默认参数
-# 无需区分图文和视频作品
-# 返回作品详细数据，包括下载地址
-download = True  # 启用自动下载作品文件
+download = True  # 是否下载作品文件
+# 返回作品详细信息，包括下载地址
 print(xhs.extract(error_demo))  # 获取数据失败时返回空字典
 print(xhs.extract(image_demo, download=download))
 print(xhs.extract(video_demo, download=download))
diff --git a/main.py b/main.py
index aee591a..3484602 100644
--- a/main.py
+++ b/main.py
@@ -3,7 +3,7 @@ from source import XHS
 
 
 def example():
-    """代码示例"""
+    """通过代码设置参数，适合二次开发"""
     # 测试链接
     error_demo = "https://www.xiaohongshu.com/explore/"
     image_demo = "https://www.xiaohongshu.com/explore/64d1b406000000000103ee8d"
@@ -11,7 +11,7 @@ def example():
     # 实例对象
     path = "./"  # 作品下载储存根路径，默认值：当前路径
     folder = "Download"  # 作品下载文件夹名称（自动创建），默认值：Download
-    proxies = None  # 代理
+    proxies = None  # 网络代理
     timeout = 5  # 网络请求超时限制，默认值：10
     chunk = 1024 * 1024  # 下载文件时，每次从服务器获取的数据块大小，单位字节
     xhs = XHS(
@@ -21,16 +21,16 @@ def example():
         timeout=timeout,
         chunk=chunk, )  # 使用自定义参数
     # xhs = XHS()  # 使用默认参数
-    # 无需区分图文和视频作品
-    # 返回作品详细数据，包括下载地址
-    download = True  # 启用自动下载作品文件
+    download = True  # 是否下载作品文件
+    # 返回作品详细信息，包括下载地址
     print(xhs.extract(error_demo))  # 获取数据失败时返回空字典
     print(xhs.extract(image_demo, download=download))
     print(xhs.extract(video_demo, download=download))
 
 
 def main():
-    xhs = XHS(**Settings().run())  # 配置文件生效
+    """读取并应用配置文件设置的参数，适合一般作品文件下载需求"""
+    xhs = XHS(**Settings().run())
     while True:
         if url := input("请输入小红书作品链接："):
             xhs.extract(url, download=True)