Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
teaSummer committed Jun 24, 2024
1 parent 2f11078 commit 899cc3c
Showing 1 changed file with 25 additions and 25 deletions.
50 changes: 25 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,34 +51,34 @@

对象有以下属性:

| 属性键名称 | 属性值类型 | 属性值描述 |
|------------|--------|--------------------------------------------------|
| `title` | String | 软件完整名称。 |
| `subtitle` | String | 可选。简写名称,若不填写此属性,将与 `title` 值保持一致。 |
| `download` | String | 可选。最新稳定版(正式版)下载地址 URL,优先填写下载源 URL。 |
| `version` | String | 可选。最新稳定版版本名/号,可填 `latest`仅在 `download` 保持版本最新时使用|
| `url` | String | 可选。GitHub 仓库地址 URL,若没有公开的开源仓库,填写官方网站地址 URL。 |
| `dev` | Object | 可选。开发版信息,见下文,尽量不提供只在 GitHub Actions 中出现的版本。 |
| 属性键名称 | 属性值类型 | 属性值描述 |
|------------|--------|---------------------------------------------|
| `title` | String | 软件完整名称。 |
| `abbr` | String | 可选。简写名称,若不填写此属性,将与 `title` 值保持一致。 |
| `download` | String | 可选。最新稳定版(正式版)下载地址 URL,优先填写下载源 URL。 |
| `version` | String | 可选。最新稳定版版本名/号,可填 `latest`仅在保持最新且不便自动修改时使用|
| `url` | String | 可选。GitHub 仓库地址 URL,若没有公开的开源仓库,填写官方网站地址 URL。 |
| `dev` | Object | 可选。开发版信息,见下文,尽量不提供只在 GitHub Actions 中出现的版本。 |

`dev` 是其中的对象,它有以下属性:

| 属性键名称 | 属性值类型 | 属性值描述 |
|------------|--------|-----------------------------------------------|
| `download` | String | 最新开发版(测试版)下载地址 URL,优先填写下载源 URL。 |
| `version` | String | 最新开发版版本名/号,可填 `latest`仅在 `download` 保持版本最新时使用|
| 属性键名称 | 属性值类型 | 属性值描述 |
|------------|--------|------------------------------------------|
| `download` | String | 最新开发版(测试版)下载地址 URL,优先填写下载源 URL。 |
| `version` | String | 最新开发版版本名/号,可填 `latest`仅在保持最新且不便自动修改时使用|

示例如下:

``` javascript
{
title: "Hello Minecraft! Launcher",
subtitle: "HMCL",
download: "https://github.com/HMCL-dev/HMCL/releases/download/release-3.5.7/HMCL-3.5.7.exe",
version: "3.5.7",
abbr: "HMCL",
download: "https://github.com/HMCL-dev/HMCL/releases/download/release-3.5.8/HMCL-3.5.8.exe",
version: "release-3.5.8",
url: "https://github.com/HMCL-dev/HMCL",
dev: {
download: "https://github.com/HMCL-dev/HMCL/releases/download/v3.5.7.245/HMCL-3.5.7.245.exe",
version: "3.5.7.245"
download: "https://github.com/HMCL-dev/HMCL/releases/download/v3.5.8.249/HMCL-3.5.8.249.exe",
version: "v3.5.8.249"
}
}
```
Expand All @@ -89,20 +89,20 @@

对象有以下属性:

| 属性键名称 | 属性值类型 | 属性值描述 |
|------------|--------|---------------------------------|
| `title` | String | 站点完整名称。 |
| `subtitle` | String | 可选。简称,若不填写此属性,将与 `title` 值保持一致。 |
| `search` | String | 搜索后跳转的地址 URL,使用 `<T>` 表示关键词。 |
| `note` | String | 可选。备注。 |
| `url` | String | 可选。站点主页地址 URL。 |
| 属性键名称 | 属性值类型 | 属性值描述 |
|----------|--------|---------------------------------|
| `title` | String | 站点完整名称。 |
| `abbr` | String | 可选。简称,若不填写此属性,将与 `title` 值保持一致。 |
| `search` | String | 搜索后跳转的地址 URL,使用 `<T>` 表示关键词。 |
| `note` | String | 可选。备注。 |
| `url` | String | 可选。站点主页地址 URL。 |

示例如下:

``` javascript
{
title: "维基百科: 原站",
subtitle: "Wiki",
abbr: "Wiki",
search: "https://zh.minecraft.wiki/?search=<T>&title=Special%3A%E6%90%9C%E7%B4%A2&fulltext=search",
note: "中文 Minecraft Wiki",
url: "https://zh.minecraft.wiki"
Expand Down

0 comments on commit 899cc3c

Please sign in to comment.