Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JusterZhu committed Jan 4, 2025
1 parent 392e493 commit 5fa9ae9
Show file tree
Hide file tree
Showing 24 changed files with 140 additions and 89 deletions.
50 changes: 38 additions & 12 deletions website/docs/doc/GeneralClient.OSS.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public sealed class GeneralClientOSS
NuGet Installation

```shell
NuGet\Install-Package GeneralUpdate.ClientCore -Version 3.0.0
NuGet\Install-Package GeneralUpdate.ClientCore -Version 9.1.0
```


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



The following example defines methods, including the usage of GeneralClientOSS.
The following example defines methods, including the usage of GeneralClientOSS , GeneralUpdateOSS.

```c#
Task.Run(async () =>
using System.Text;
using GeneralUpdate.ClientCore;
using GeneralUpdate.Common.Shared.Object;

var paramsOSS = new GlobalConfigInfoOSS
{
Url = "http://localhost:5000/packages/versions.json",
CurrentVersion = "1.0.0.0",
VersionFileName = "versions.json",
AppName = "OSSClientSample.exe",
Encoding = Encoding.UTF8.WebName
};

await GeneralClientOSS.Start(paramsOSS, "OSSUpgradeSample.exe");
```



```
using GeneralUpdate.Core;
/*
* GeneralUpdateOSS will by default read the JSON content of GlobalConfigInfoOSS stored in the system environment variables by GeneralClientOSS
* , and developers do not need to be concerned with the entire process.
*
* Environment.GetEnvironmentVariable("GlobalConfigInfoOSS", EnvironmentVariableTarget.User);
*
* Typically, GeneralClientOSS and GeneralUpdateOSS appear as a pair.
*/
try
{
await GeneralUpdateOSS.Start();
}
catch (Exception ex)
{
var url = "http://192.168.xxx.xxx";
var apk = "com.companyname.generalupdate.ossclient.apk";
var authority = "com.generalupdate.oss.fileprovider";
var currentVersion = "1.0.0.0";
var versionFileName = "version.json";
GeneralClientOSS.AddListenerDownloadProcess(OnOSSDownload);
GeneralClientOSS.AddListenerException(OnException);
await GeneralClientOSS.Start(new ParamsOSS(url, apk, authority, currentVersion, versionFileName));
});
Console.WriteLine(ex.Message);
}
```


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


Expand Down
10 changes: 1 addition & 9 deletions website/docs/doc/GeneralUpdate.Bowl.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,6 @@ sidebar_position: 3

---

#### Background Story

![](imgs\bowl.jpg)

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.

![](imgs\mybowl.jpg)

### Definition

Namespace: GeneralUpdate.Bowl
Expand All @@ -27,7 +19,7 @@ public sealed class Bowl
NuGet Installation

```shell
NuGet\Install-Package GeneralUpdate.Bowl -Version 1.0.0
NuGet\Install-Package GeneralUpdate.Bowl -Version 9.1.0
```

### Example
Expand Down
2 changes: 1 addition & 1 deletion website/docs/doc/GeneralUpdate.ClientCore.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public class GeneralClientBootstrap : AbstractBootstrap<GeneralClientBootstrap,
NuGet Installation

```shell
NuGet\Install-Package GeneralUpdate.ClientCore -Version 3.0.0
NuGet\Install-Package GeneralUpdate.ClientCore -Version 9.1.0
```

### Example
Expand Down
2 changes: 1 addition & 1 deletion website/docs/doc/GeneralUpdate.Common.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ This component primarily serves as a library for the infrastructure and shared c
NuGet Installation

```shell
NuGet\Install-Package GeneralUpdate.Common -Version 3.0.0
NuGet\Install-Package GeneralUpdate.Common -Version 9.1.0
```
2 changes: 1 addition & 1 deletion website/docs/doc/GeneralUpdate.Core.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ public class GeneralUpdateBootstrap : AbstractBootstrap<GeneralUpdateBootstrap,
NuGet Installation

```shell
NuGet\Install-Package GeneralUpdate.Core -Version 3.0.0
NuGet\Install-Package GeneralUpdate.Core -Version 9.1.0
```

### Example
Expand Down
2 changes: 1 addition & 1 deletion website/docs/doc/GeneralUpdate.Differential.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ public sealed class DifferentialCore
NuGet Installation

```shell
NuGet\Install-Package GeneralUpdate.Differential -Version 3.0.0
NuGet\Install-Package GeneralUpdate.Differential -Version 9.1.0
```

### Example
Expand Down
2 changes: 1 addition & 1 deletion website/docs/doc/UpgradeHub.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public class UpgradeHubService : IUpgradeHubService
NuGet Installation

```shell
NuGet\Install-Package GeneralUpdate.ClientCore -Version 1.0.0
NuGet\Install-Package GeneralUpdate.ClientCore -Version 9.1.0
```

### Example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public sealed class GeneralClientOSS
NuGet Installation

```shell
NuGet\Install-Package GeneralUpdate.ClientCore -Version 3.0.0
NuGet\Install-Package GeneralUpdate.ClientCore -Version 9.1.0
```


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



The following example defines methods, including the usage of GeneralClientOSS.
The following example defines methods, including the usage of GeneralClientOSS , GeneralUpdateOSS.

```c#
Task.Run(async () =>
using System.Text;
using GeneralUpdate.ClientCore;
using GeneralUpdate.Common.Shared.Object;

var paramsOSS = new GlobalConfigInfoOSS
{
Url = "http://localhost:5000/packages/versions.json",
CurrentVersion = "1.0.0.0",
VersionFileName = "versions.json",
AppName = "OSSClientSample.exe",
Encoding = Encoding.UTF8.WebName
};

await GeneralClientOSS.Start(paramsOSS, "OSSUpgradeSample.exe");
```



```
using GeneralUpdate.Core;
/*
* GeneralUpdateOSS will by default read the JSON content of GlobalConfigInfoOSS stored in the system environment variables by GeneralClientOSS
* , and developers do not need to be concerned with the entire process.
*
* Environment.GetEnvironmentVariable("GlobalConfigInfoOSS", EnvironmentVariableTarget.User);
*
* Typically, GeneralClientOSS and GeneralUpdateOSS appear as a pair.
*/
try
{
await GeneralUpdateOSS.Start();
}
catch (Exception ex)
{
var url = "http://192.168.xxx.xxx";
var apk = "com.companyname.generalupdate.ossclient.apk";
var authority = "com.generalupdate.oss.fileprovider";
var currentVersion = "1.0.0.0";
var versionFileName = "version.json";
GeneralClientOSS.AddListenerDownloadProcess(OnOSSDownload);
GeneralClientOSS.AddListenerException(OnException);
await GeneralClientOSS.Start(new ParamsOSS(url, apk, authority, currentVersion, versionFileName));
});
Console.WriteLine(ex.Message);
}
```


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,6 @@ Technologies involved in the introduction (including but not limited to operatin
| DDD | Popular architecture/design pattern | https://learn.microsoft.com/zh-cn/dotnet/architecture/microservices/microservice-ddd-cqrs-patterns/ |
| MVVM | Popular architecture/design pattern | https://learn.microsoft.com/zh-cn/dotnet/architecture/maui/mvvm |
| AOT | Full support for AOT compilation across all GeneralUpdate components | https://learn.microsoft.com/en-us/dotnet/core/deploying/native-aot/ |
| Linux (Ubuntu) | Full support for Linux operating systems | https://cn.ubuntu.com/ |
| Windows | Supports operating systems from Windows 7 onwards | https://support.microsoft.com/zh-cn/welcometowindows |
| LoongOS | Domestic (Loongson) operating system (New World) | https://www.loongson.cn/system/loongos |
| ...... | ...... | |


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,6 @@ sidebar_position: 3

---

#### Background Story

![](imgs\bowl.jpg)

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.

![](imgs\mybowl.jpg)

### Definition

Namespace: GeneralUpdate.Bowl
Expand All @@ -27,7 +19,7 @@ public sealed class Bowl
NuGet Installation

```shell
NuGet\Install-Package GeneralUpdate.Bowl -Version 3.0.0
NuGet\Install-Package GeneralUpdate.Bowl -Version 9.1.0
```

### Example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public class GeneralClientBootstrap : AbstractBootstrap<GeneralClientBootstrap,
NuGet Installation

```shell
NuGet\Install-Package GeneralUpdate.ClientCore -Version 3.0.0
NuGet\Install-Package GeneralUpdate.ClientCore -Version 9.1.0
```

### Example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ This component primarily serves as a library for the infrastructure and shared c
NuGet Installation

```shell
NuGet\Install-Package GeneralUpdate.Common -Version 3.0.0
NuGet\Install-Package GeneralUpdate.Common -Version 9.1.0
```
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ public class GeneralUpdateBootstrap : AbstractBootstrap<GeneralUpdateBootstrap,
NuGet Installation

```shell
NuGet\Install-Package GeneralUpdate.Core -Version 3.0.0
NuGet\Install-Package GeneralUpdate.Core -Version 9.1.0
```

### Example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ public sealed class DifferentialCore
NuGet Installation

```shell
NuGet\Install-Package GeneralUpdate.Differential -Version 3.0.0
NuGet\Install-Package GeneralUpdate.Differential -Version 9.1.0
```

### Example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public class UpgradeHubService : IUpgradeHubService
NuGet Installation

```shell
NuGet\Install-Package GeneralUpdate.ClientCore -Version 1.0.0
NuGet\Install-Package GeneralUpdate.ClientCore -Version 9.1.0
```

### Example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,15 @@ tags: [log]

# 📒Release log

## 📍2025-01-04 9.1.0

- Add a feature to skip specified folders (specified parameters will be passed through Client and Upgrade).
- Add Scheme and Token parameters to the HTTP request headers.
- Fix the issue of OSS Samples failing to update.
- Modify the OSS feature to not delete the update package upon completion.
- Fix the issue in Samples where only the Client updates, not the Upgrade. (The looping update occurred because the local version number was not changed)
- Upgrade all Samples from version 9.0.0 to 9.1.0.



## 📍2024-11-28
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public sealed class GeneralClientOSS
nuget安装

```shell
NuGet\Install-Package GeneralUpdate.ClientCore -Version 3.0.0
NuGet\Install-Package GeneralUpdate.ClientCore -Version 9.1.0
```


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



以下示例定义方法,包含GeneralClientOSS使用方法。
以下示例定义方法,包含GeneralClientOSS、GeneralUpdateOSS 使用示例:

```c#
Task.Run(async () =>
using System.Text;
using GeneralUpdate.ClientCore;
using GeneralUpdate.Common.Shared.Object;

var paramsOSS = new GlobalConfigInfoOSS
{
Url = "http://localhost:5000/packages/versions.json",
CurrentVersion = "1.0.0.0",
VersionFileName = "versions.json",
AppName = "OSSClientSample.exe",
Encoding = Encoding.UTF8.WebName
};

await GeneralClientOSS.Start(paramsOSS, "OSSUpgradeSample.exe");
```



```
using GeneralUpdate.Core;
/*
* GeneralUpdateOSS will by default read the JSON content of GlobalConfigInfoOSS stored in the system environment variables by GeneralClientOSS
* , and developers do not need to be concerned with the entire process.
*
* Environment.GetEnvironmentVariable("GlobalConfigInfoOSS", EnvironmentVariableTarget.User);
*
* Typically, GeneralClientOSS and GeneralUpdateOSS appear as a pair.
*/
try
{
await GeneralUpdateOSS.Start();
}
catch (Exception ex)
{
var url = "http://192.168.xxx.xxx";
var apk = "com.companyname.generalupdate.ossclient.apk";
var authority = "com.generalupdate.oss.fileprovider";
var currentVersion = "1.0.0.0";
var versionFileName = "version.json";
GeneralClientOSS.AddListenerDownloadProcess(OnOSSDownload);
GeneralClientOSS.AddListenerException(OnException);
await GeneralClientOSS.Start(new ParamsOSS(url, apk, authority, currentVersion, versionFileName));
});
Console.WriteLine(ex.Message);
}
```


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,6 @@ GeneralLibrary团队针对企业级应用开发了GeneralSpacestation服务,
| DDD | 当下流行的架构\设计模式 | https://learn.microsoft.com/zh-cn/dotnet/architecture/microservices/microservice-ddd-cqrs-patterns/ |
| MVVM | 当下流行的架构\设计模式 | https://learn.microsoft.com/zh-cn/dotnet/architecture/maui/mvvm |
| AOT | GeneralUpdate所有组件全线支持、兼容AOT编译 | https://learn.microsoft.com/en-us/dotnet/core/deploying/native-aot/ |
| Linux (Ubuntu) | 本产品全线支持Linux操作系统 | https://cn.ubuntu.com/ |
| Windows | 支持win7以上版本的操作系统 | https://support.microsoft.com/zh-cn/welcometowindows |
| LoongOS | 国产(龙芯)操作系统(新世界) | https://www.loongson.cn/system/loongos |
| ...... | ...... | |


Expand Down
Loading

0 comments on commit 5fa9ae9

Please sign in to comment.