Refactor README files to enhance clarity and structure, updating sections for documentation and quick start, while removing outdated content related to installation and usage examples.

Author: lijy91

README-ZH.md

@@ -22,34 +22,17 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-- [auto\_updater](#auto_updater)
-  - [平台支持](#平台支持)
-  - [快速开始](#快速开始)
-    - [安装](#安装)
-      - [⚠️ Windows requirements](#️-windows-requirements)
-    - [用法](#用法)
-    - [发布你的应用](#发布你的应用)
-      - [生成私钥](#生成私钥)
-        - [macOS](#macos)
-        - [Windows](#windows)
-      - [打包应用](#打包应用)
-        - [macOS](#macos-1)
-        - [Windows](#windows-1)
-      - [获取签名](#获取签名)
-        - [macOS](#macos-2)
-        - [Windows](#windows-2)
-      - [分发应用](#分发应用)
-  - [故障排除](#故障排除)
-    - [macOS](#macos-3)
-  - [谁在用使用它？](#谁在用使用它)
-  - [API](#api)
-    - [AutoUpdater](#autoupdater)
-      - [Methods](#methods)
-        - [setFeedURL](#setfeedurl)
-        - [checkForUpdates](#checkforupdates)
-        - [setScheduledCheckInterval](#setscheduledcheckinterval)
-  - [相关链接](#相关链接)
-  - [许可证](#许可证)
+- [平台支持](#%E5%B9%B3%E5%8F%B0%E6%94%AF%E6%8C%81)
+- [文档](#%E6%96%87%E6%A1%A3)
+- [谁在用使用它？](#%E8%B0%81%E5%9C%A8%E7%94%A8%E4%BD%BF%E7%94%A8%E5%AE%83)
+- [API](#api)
+  - [AutoUpdater](#autoupdater)
+    - [Methods](#methods)
+      - [setFeedURL](#setfeedurl)
+      - [checkForUpdates](#checkforupdates)
+      - [setScheduledCheckInterval](#setscheduledcheckinterval)
+- [相关链接](#%E7%9B%B8%E5%85%B3%E9%93%BE%E6%8E%A5)
+- [许可证](#%E8%AE%B8%E5%8F%AF%E8%AF%81)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -59,280 +42,11 @@
 | :---: | :---: | :-----: |
 |  ➖   |  ✔️   |   ✔️    |
 
-## 快速开始
+## 文档
 
-### 安装
-
-将此添加到你的软件包的 pubspec.yaml 文件：
-
-```yaml
-dependencies:
-  auto_updater: ^0.2.0
-```
-
-或
-
-```yaml
-dependencies:
-  auto_updater:
-    git:
-      path: packages/auto_updater
-      url: https://github.com/leanflutter/auto_updater.git
-      ref: main
-```
-
-#### ⚠️ Windows requirements
-
-- `openssl`
-
-运行以下命令：
-
-> 使用 [Chocolatey](https://chocolatey.org/install)
-
-```
-choco install openssl
-```
-
-### 用法
-
-```dart
-import 'package:auto_updater/auto_updater.dart';
-
-void main() async {
-  // 必须加上这一行。
-  WidgetsFlutterBinding.ensureInitialized();
-
-  String feedURL = 'http://localhost:5002/appcast.xml';
-  await autoUpdater.setFeedURL(feedURL);
-  await autoUpdater.checkForUpdates();
-  await autoUpdater.setScheduledCheckInterval(3600);
-
-  runApp(MyApp());
-}
-```
-
-> 请看这个插件的示例应用，以了解完整的例子。
-
-### 发布你的应用
-
-#### 生成私钥
-
-运行以下命令：
-
-```bash
-dart run auto_updater:generate_keys
-```
-
-> 需要分别在 `macOS` 和 `Windows` 系统中运行该命令。
-
-##### macOS
-
-准备使用 `EdDSA` 签名算法进行签名：
-
-输出：
-
-```
-A key has been generated and saved in your keychain. Add the `SUPublicEDKey` key to
-the Info.plist of each app for which you intend to use Sparkle for distributing
-updates. It should appear like this:
-
-    <key>SUPublicEDKey</key>
-    <string>pfIShU4dEXqPd5ObYNfDBiQWcXozk7estwzTnF9BamQ=</string>
-```
-
-更改文件 `macos/Runner/Info.plist` 如下：
-
-```diff
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
-
-  ...
-
-+	<key>SUPublicEDKey</key>
-+	<string>bHaXClrRGMmKoKP/3HJnr/jn2ODTRPAM3VZhhkI9ZvY=</string>
-</dict>
-</plist>
-```
-
-##### Windows
-
-准备使用 `DSA` 签名算法进行签名：
-
-输出：
-
-```
-Generated two files:
-dsa_priv.pem: your private key. Keep it secret and don't share it!
-dsa_pub.pem: public counterpart to include in youe app.
-BACK UP YOUR PRIVATE KEY AND KEEP IT SAFE!
-If you lose it, your users will be unable to upgrade!
-```
-
-> 命令将为你生成私钥（`dsa_priv.pem`）及公钥（`dsa_pub.pem`），请备份你的私钥并确保其安全，并将公钥作为 Windows 资源添加到项目中。
-
-更改文件 `windows/runner/Runner.rc` 如下：
-
-```diff
-
-...
-
-+/////////////////////////////////////////////////////////////////////////////
-+//
-+// WinSparkle
-+//
-
-+// And verify signature using DSA public key:
-+DSAPub      DSAPEM      "../../dsa_pub.pem"
-```
-
-#### 打包应用
-
-> 为了简化打包的过程，这里使用了 [Fastforge](https://fastforge.dev) ，一个专门用于打包和发布 Flutter 应用的完整工具。
-
-将 `distribute_options.yaml` 添加到你的项目根目录。
-
-```yaml
-output: dist/
-releases:
-  - name: prod
-    jobs:
-      - name: macos-zip
-        package:
-          platform: macos
-          target: zip
-          build_args:
-            dart-define:
-              APP_ENV: dev
-      # 查看完整文档：https://fastforge.dev/makers/exe
-      - name: windows-exe
-        package:
-          platform: windows
-          target: exe
-          build_args:
-            dart-define:
-              APP_ENV: dev
-```
-
-##### macOS
-
-运行以下命令：
-
-```
-fastforge release --name prod --jobs macos-zip
-```
-
-##### Windows
-
-运行以下命令：
-
-```
-fastforge release --name prod --jobs windows-exe
-```
-
-#### 获取签名
-
-##### macOS
-
-运行以下命令：
-
-```
-dart run auto_updater:sign_update dist/1.1.0+2/auto_updater_example-1.1.0+2-macos.zip
-```
-
-输出：
-
-```
-sparkle:edSignature="pbdyPt92pnPkzLfQ7BhS9hbjcV9/ndkzSIlWjFQIUMcaCNbAFO2fzl0tISMNJApG2POTkZY0/kJQ2yZYOSVgAA==" length="13400992"
-```
-
-将获得的新签名更新到 `appcast.xml` 文件 `enclosure` 节点的 `sparkle:edSignature` 属性值。
-
-##### Windows
-
-运行以下命令：
-
-```
-dart run auto_updater:sign_update dist/1.1.0+2/auto_updater_example-1.1.0+2-windows-setup.exe
-```
-
-输出：
-
-```
-
-sparkle:dsaSignature="MEUCIQCVbVzVID7H3aUzAY5znpi+ySZKznkukV8whlMFzKh66AIgREUGOmvavlcg6hwAwkb2o4IqVE/D56ipIBshIqCH8rk=" length="13400992"
-```
-
-将获得的新签名更新到 `appcast.xml` 文件 `enclosure` 节点的 `sparkle:dsaSignature` 属性值。
-
-#### 分发应用
-
-将 `appcast.xml` 添加到你的项目 `dist/` 目录。
-
-```xml
-<?xml version="1.0" encoding="UTF-8"?>
-<rss version="2.0" xmlns:sparkle="http://www.andymatuschak.org/xml-namespaces/sparkle">
-    <channel>
-        <title>auto_updater_example</title>
-        <description>Most recent updates to auto_updater_example</description>
-        <language>en</language>
-        <item>
-            <title>Version 1.1.0</title>
-            <!-- 对于 macOS 项目，建议将 'sparkle:version' 和 'sparkle:shortVersionString' 添加到项目节点中，而不是作为 'enclosure' 的一部分。 -->
-            <sparkle:version>2</sparkle:version>
-            <sparkle:shortVersionString>1.1.0</sparkle:shortVersionString>
-            <sparkle:releaseNotesLink>
-                https://your_domain/your_path/release_notes.html
-            </sparkle:releaseNotesLink>
-            <pubDate>Sun, 16 Feb 2022 12:00:00 +0800</pubDate>
-            <enclosure url="1.1.0+2/auto_updater_example-1.1.0+2-macos.zip"
-                       sparkle:edSignature="pbdyPt92pnPkzLfQ7BhS9hbjcV9/ndkzSIlWjFQIUMcaCNbAFO2fzl0tISMNJApG2POTkZY0/kJQ2yZYOSVgAA=="
-                       sparkle:os="macos"
-                       length="13400992"
-                       type="application/octet-stream" />
-        </item>
-        <item>
-            <title>Version 1.1.0</title>
-            <sparkle:releaseNotesLink>
-                https://your_domain/your_path/release_notes.html
-            </sparkle:releaseNotesLink>
-            <pubDate>Sun, 16 Feb 2022 12:00:00 +0800</pubDate>
-            <enclosure url="1.1.0+2/auto_updater_example-1.1.0+2-windows.exe"
-                       sparkle:dsaSignature="MEUCIQCVbVzVID7H3aUzAY5znpi+ySZKznkukV8whlMFzKh66AIgREUGOmvavlcg6hwAwkb2o4IqVE/D56ipIBshIqCH8rk="
-                       sparkle:version="1.1.0+2"
-                       sparkle:os="windows"
-                       length="0"
-                       type="application/octet-stream" />
-        </item>
-    </channel>
-</rss>
-```
-
-> 本示例中 `macOS` 和 `Windows` 使用同一个 `appcast.xml` 文件，你需根据配置 `sparkle:os` 属性的值。
-
-启动测试更新服务器：
-
-```
-cd dist/
-serve -l 5002
-```
-
-## 故障排除
-
-### macOS
-
-- 确保按照 [Sparkle 文档](https://sparkle-project.org/documentation/)中的说明添加了 sparkle pod
-- 通过将以下内容添加到您的授权文件以进行调试和发布，确保您已添加并启用应用程序的网络功能并禁用沙箱以进行发布
-
-```
-<key>com.apple.security.network.client</key>
-  <true/>
-<key>com.apple.security.network.server</key>
-  <true/>
-<key>com.apple.security.app-sandbox</key>
-  <false/>
-```
+- [快速开始](https://leanflutter.dev/zh/documentation/auto_updater/quick-start)
+- [API 参考](https://pub.dev/documentation/auto_updater/latest/auto_updater/)
+- [更新日志](https://pub.dev/packages/auto_updater/changelog)
 
 ## 谁在用使用它？