Skip to content

Commit 5fa9ae9

Browse files
JusterZhuJusterZhu
committed
update readme
1 parent 392e493 commit 5fa9ae9

24 files changed

+140
-89
lines changed

‎website/docs/doc/GeneralClient.OSS.md‎

Lines changed: 38 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ public sealed class GeneralClientOSS
2727
NuGet Installation
2828

2929
```shell
30-
NuGet\Install-Package GeneralUpdate.ClientCore -Version 3.0.0
30+
NuGet\Install-Package GeneralUpdate.ClientCore -Version 9.1.0
3131
```
3232

3333

@@ -54,20 +54,46 @@ NuGet\Install-Package GeneralUpdate.ClientCore -Version 3.0.0
5454

5555

5656

57-
The following example defines methods, including the usage of GeneralClientOSS.
57+
The following example defines methods, including the usage of GeneralClientOSS , GeneralUpdateOSS.
5858

5959
```c#
60-
Task.Run(async () =>
60+
using System.Text;
61+
using GeneralUpdate.ClientCore;
62+
using GeneralUpdate.Common.Shared.Object;
63+
64+
var paramsOSS = new GlobalConfigInfoOSS
65+
{
66+
Url = "http://localhost:5000/packages/versions.json",
67+
CurrentVersion = "1.0.0.0",
68+
VersionFileName = "versions.json",
69+
AppName = "OSSClientSample.exe",
70+
Encoding = Encoding.UTF8.WebName
71+
};
72+
73+
await GeneralClientOSS.Start(paramsOSS, "OSSUpgradeSample.exe");
74+
```
75+
76+
77+
78+
```
79+
using GeneralUpdate.Core;
80+
81+
/*
82+
* GeneralUpdateOSS will by default read the JSON content of GlobalConfigInfoOSS stored in the system environment variables by GeneralClientOSS
83+
* , and developers do not need to be concerned with the entire process.
84+
*
85+
* Environment.GetEnvironmentVariable("GlobalConfigInfoOSS", EnvironmentVariableTarget.User);
86+
*
87+
* Typically, GeneralClientOSS and GeneralUpdateOSS appear as a pair.
88+
*/
89+
try
90+
{
91+
await GeneralUpdateOSS.Start();
92+
}
93+
catch (Exception ex)
6194
{
62-
var url = "http://192.168.xxx.xxx";
63-
var apk = "com.companyname.generalupdate.ossclient.apk";
64-
var authority = "com.generalupdate.oss.fileprovider";
65-
var currentVersion = "1.0.0.0";
66-
var versionFileName = "version.json";
67-
GeneralClientOSS.AddListenerDownloadProcess(OnOSSDownload);
68-
GeneralClientOSS.AddListenerException(OnException);
69-
await GeneralClientOSS.Start(new ParamsOSS(url, apk, authority, currentVersion, versionFileName));
70-
});
95+
Console.WriteLine(ex.Message);
96+
}
7197
```
7298

7399

‎website/docs/doc/GeneralSpacestation.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,6 @@ Technologies involved in the introduction (including but not limited to operatin
5454
| DDD | Popular architecture/design pattern | https://learn.microsoft.com/zh-cn/dotnet/architecture/microservices/microservice-ddd-cqrs-patterns/ |
5555
| MVVM | Popular architecture/design pattern | https://learn.microsoft.com/zh-cn/dotnet/architecture/maui/mvvm |
5656
| AOT | Full support for AOT compilation across all GeneralUpdate components | https://learn.microsoft.com/en-us/dotnet/core/deploying/native-aot/ |
57-
| Linux (Ubuntu) | Full support for Linux operating systems | https://cn.ubuntu.com/ |
58-
| Windows | Supports operating systems from Windows 7 onwards | https://support.microsoft.com/zh-cn/welcometowindows |
59-
| LoongOS | Domestic (Loongson) operating system (New World) | https://www.loongson.cn/system/loongos |
6057
| ...... | ...... | |
6158

6259

‎website/docs/doc/GeneralUpdate.Bowl.md‎

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,6 @@ sidebar_position: 3
44

55
---
66

7-
#### Background Story
8-
9-
![](imgs\bowl.jpg)
10-
11-
Bowl is an orange cat owned by the author Juster. The reason for naming an orange cat or component "Bowl" is because orange cats tend to get fat easily. Juster hopes it will eat only a small bowl at a time, hence the name "Little Bowl." In the GeneralUpdate system, if the upgrade process encounters significant issues, Bowl will step in to restore the situation and analyze the reasons for failure.
12-
13-
![](imgs\mybowl.jpg)
14-
157
### Definition
168

179
Namespace: GeneralUpdate.Bowl
@@ -27,7 +19,7 @@ public sealed class Bowl
2719
NuGet Installation
2820

2921
```shell
30-
NuGet\Install-Package GeneralUpdate.Bowl -Version 1.0.0
22+
NuGet\Install-Package GeneralUpdate.Bowl -Version 9.1.0
3123
```
3224

3325
### Example

‎website/docs/doc/GeneralUpdate.ClientCore.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ public class GeneralClientBootstrap : AbstractBootstrap<GeneralClientBootstrap,
1919
NuGet Installation
2020

2121
```shell
22-
NuGet\Install-Package GeneralUpdate.ClientCore -Version 3.0.0
22+
NuGet\Install-Package GeneralUpdate.ClientCore -Version 9.1.0
2323
```
2424

2525
### Example

‎website/docs/doc/GeneralUpdate.Common.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@ This component primarily serves as a library for the infrastructure and shared c
1111
NuGet Installation
1212

1313
```shell
14-
NuGet\Install-Package GeneralUpdate.Common -Version 3.0.0
14+
NuGet\Install-Package GeneralUpdate.Common -Version 9.1.0
1515
```

‎website/docs/doc/GeneralUpdate.Core.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ public class GeneralUpdateBootstrap : AbstractBootstrap<GeneralUpdateBootstrap,
1515
NuGet Installation
1616

1717
```shell
18-
NuGet\Install-Package GeneralUpdate.Core -Version 3.0.0
18+
NuGet\Install-Package GeneralUpdate.Core -Version 9.1.0
1919
```
2020

2121
### Example

‎website/docs/doc/GeneralUpdate.Differential.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ public sealed class DifferentialCore
1515
NuGet Installation
1616

1717
```shell
18-
NuGet\Install-Package GeneralUpdate.Differential -Version 3.0.0
18+
NuGet\Install-Package GeneralUpdate.Differential -Version 9.1.0
1919
```
2020

2121
### Example

‎website/docs/doc/UpgradeHub.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ public class UpgradeHubService : IUpgradeHubService
1919
NuGet Installation
2020

2121
```shell
22-
NuGet\Install-Package GeneralUpdate.ClientCore -Version 1.0.0
22+
NuGet\Install-Package GeneralUpdate.ClientCore -Version 9.1.0
2323
```
2424

2525
### Example

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

Lines changed: 38 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ public sealed class GeneralClientOSS
2727
NuGet Installation
2828

2929
```shell
30-
NuGet\Install-Package GeneralUpdate.ClientCore -Version 3.0.0
30+
NuGet\Install-Package GeneralUpdate.ClientCore -Version 9.1.0
3131
```
3232

3333

@@ -54,20 +54,46 @@ NuGet\Install-Package GeneralUpdate.ClientCore -Version 3.0.0
5454

5555

5656

57-
The following example defines methods, including the usage of GeneralClientOSS.
57+
The following example defines methods, including the usage of GeneralClientOSS , GeneralUpdateOSS.
5858

5959
```c#
60-
Task.Run(async () =>
60+
using System.Text;
61+
using GeneralUpdate.ClientCore;
62+
using GeneralUpdate.Common.Shared.Object;
63+
64+
var paramsOSS = new GlobalConfigInfoOSS
65+
{
66+
Url = "http://localhost:5000/packages/versions.json",
67+
CurrentVersion = "1.0.0.0",
68+
VersionFileName = "versions.json",
69+
AppName = "OSSClientSample.exe",
70+
Encoding = Encoding.UTF8.WebName
71+
};
72+
73+
await GeneralClientOSS.Start(paramsOSS, "OSSUpgradeSample.exe");
74+
```
75+
76+
77+
78+
```
79+
using GeneralUpdate.Core;
80+
81+
/*
82+
* GeneralUpdateOSS will by default read the JSON content of GlobalConfigInfoOSS stored in the system environment variables by GeneralClientOSS
83+
* , and developers do not need to be concerned with the entire process.
84+
*
85+
* Environment.GetEnvironmentVariable("GlobalConfigInfoOSS", EnvironmentVariableTarget.User);
86+
*
87+
* Typically, GeneralClientOSS and GeneralUpdateOSS appear as a pair.
88+
*/
89+
try
90+
{
91+
await GeneralUpdateOSS.Start();
92+
}
93+
catch (Exception ex)
6194
{
62-
var url = "http://192.168.xxx.xxx";
63-
var apk = "com.companyname.generalupdate.ossclient.apk";
64-
var authority = "com.generalupdate.oss.fileprovider";
65-
var currentVersion = "1.0.0.0";
66-
var versionFileName = "version.json";
67-
GeneralClientOSS.AddListenerDownloadProcess(OnOSSDownload);
68-
GeneralClientOSS.AddListenerException(OnException);
69-
await GeneralClientOSS.Start(new ParamsOSS(url, apk, authority, currentVersion, versionFileName));
70-
});
95+
Console.WriteLine(ex.Message);
96+
}
7197
```
7298

7399

‎website/i18n/en/docusaurus-plugin-content-docs/current/docs/doc/GeneralSpacestation.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,6 @@ Technologies involved in the introduction (including but not limited to operatin
5454
| DDD | Popular architecture/design pattern | https://learn.microsoft.com/zh-cn/dotnet/architecture/microservices/microservice-ddd-cqrs-patterns/ |
5555
| MVVM | Popular architecture/design pattern | https://learn.microsoft.com/zh-cn/dotnet/architecture/maui/mvvm |
5656
| AOT | Full support for AOT compilation across all GeneralUpdate components | https://learn.microsoft.com/en-us/dotnet/core/deploying/native-aot/ |
57-
| Linux (Ubuntu) | Full support for Linux operating systems | https://cn.ubuntu.com/ |
58-
| Windows | Supports operating systems from Windows 7 onwards | https://support.microsoft.com/zh-cn/welcometowindows |
59-
| LoongOS | Domestic (Loongson) operating system (New World) | https://www.loongson.cn/system/loongos |
6057
| ...... | ...... | |
6158

6259

0 commit comments

Comments
 (0)