update: doc

Author: JusterZhu

src/Compress/CompressSample/CompressSample.csproj

@@ -8,7 +8,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-      <PackageReference Include="GeneralUpdate.Core" Version="9.1.4" />
+      <PackageReference Include="GeneralUpdate.Core" Version="9.1.5" />
     </ItemGroup>
 
 </Project>

src/Compress/CompressSample/Program.cs

@@ -1,9 +1,28 @@
-using System.Text;
+using System.Diagnostics;
+using System.Text;
 using GeneralUpdate.Common.Compress;
 using GeneralUpdate.Common.Shared.Object;
 
 var source = @"D:\packet\release";
-var target = @"D:\packet\1.zip";
-CompressProvider.Compress(Format.ZIP,source,target, false, Encoding.UTF8);
-CompressProvider.Decompress(Format.ZIP,target,source, Encoding.UTF8);
-Console.WriteLine($"Done {File.Exists(target)}");
+var target = @"D:\packet\update.zip";
+//CompressProvider.Compress(Format.ZIP,source,target, false, Encoding.UTF8);
+//CompressProvider.Decompress(Format.ZIP,target,source, Encoding.UTF8);
+Decompress(source, target);
+Console.WriteLine($"Done {File.Exists(target)}");
+
+void Decompress(string source, string target)
+{
+    try
+    {
+        //var zipFilePath = Path.Combine(_appPath, $"{version.PacketName}{Format.ZIP}");
+        CompressProvider.Decompress(Format.ZIP, target, source, Encoding.UTF8);
+
+        if (!File.Exists(target)) return;
+        File.SetAttributes(target, FileAttributes.Normal);
+        File.Delete(target);
+    }
+    catch (Exception e)
+    {
+        Debug.WriteLine(e.Message);
+    }
+}

website/docs/doc/GeneralClient.OSS.md

@@ -64,6 +64,17 @@ public sealed class GeneralClientOSS
 
 5. After the Upgrade completes, it starts the Client and self-closes. The update ends. Compared to the GeneralUpdateBootstrap function, the GeneralUpdateOSS function has a very low usage threshold. If the company does not have high requirements for automatic updates, this feature can be used. In summary, this function downloads the version.json and updates based on the content in the file, downloading each version's update package and extracting it to complete the update.
 
+6. Since the OSS functionality does not include a blacklist mechanism, when creating the update.zip, please ensure that the files used internally by the following components are not added to the package, or directly release them as a single file to avoid occupying space and reducing update complexity.
+
+
+```json
+"Microsoft.Bcl.AsyncInterfaces.dll",
+"System.Collections.Immutable.dll", 
+"System.IO.Pipelines.dll", 
+"System.Text.Encodings.Web.dll",
+"System.Text.Json.dll"
+```
+
 
 
 The following example defines methods, including the usage of GeneralClientOSS , GeneralUpdateOSS.

website/i18n/en/docusaurus-plugin-content-docs/current/docs/doc/GeneralClient.OSS.md

@@ -64,6 +64,16 @@ public sealed class GeneralClientOSS
 
 5. After the Upgrade completes, it starts the Client and self-closes. The update ends. Compared to the GeneralUpdateBootstrap function, the GeneralUpdateOSS function has a very low usage threshold. If the company does not have high requirements for automatic updates, this feature can be used. In summary, this function downloads the version.json and updates based on the content in the file, downloading each version's update package and extracting it to complete the update.
 
+6. Since the OSS functionality does not include a blacklist mechanism, when creating the update.zip, please ensure that the files used internally by the following components are not added to the package, or directly release them as a single file to avoid occupying space and reducing update complexity.
+
+```json
+"Microsoft.Bcl.AsyncInterfaces.dll",
+"System.Collections.Immutable.dll", 
+"System.IO.Pipelines.dll", 
+"System.Text.Encodings.Web.dll",
+"System.Text.Json.dll"
+```
+
 
 
 The following example defines methods, including the usage of GeneralClientOSS , GeneralUpdateOSS.

website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/doc/GeneralClient.OSS.md

@@ -64,6 +64,16 @@ public sealed class GeneralClientOSS
 
 5.Upgrade更新完成之后把Client启动起来，自我关闭。更新结束。 GeneralUpdateOSS的功能和GeneralUpdateBootstrap功能对比来说，使用的门槛非常低如果公司对自动 更新的要求不高的话可以使用这个功能。一句话概括这个功能就是下载version.json根据文件里的内容去逐 版本下载更新包，下载下来之后直接解压更新就结束了。
 
+6.由于OSS功能没有包含黑名单机制，制作update.zip时需要注意请勿将以下组件内部使用的文件添加到包内，或直接发布成single file避免占用降低更新复杂度。
+
+```json
+"Microsoft.Bcl.AsyncInterfaces.dll",
+"System.Collections.Immutable.dll", 
+"System.IO.Pipelines.dll", 
+"System.Text.Encodings.Web.dll",
+"System.Text.Json.dll"
+```
+
 
 
 以下示例定义方法，包含GeneralClientOSS、GeneralUpdateOSS 使用示例：