fix: 更新 README.md 中的 tagline,明确工具功能;简化客户端识别文档内容

This commit is contained in:
MKStoler1024 2025-01-31 18:46:05 +00:00
parent 304889f6d4
commit 30c620422c
2 changed files with 6 additions and 15 deletions

View File

@ -10,7 +10,7 @@ heroImageStyle:
bgImageStyle: bgImageStyle:
background-attachment: fixed background-attachment: fixed
heroText: ExamAware 文档 heroText: ExamAware 文档
tagline: 适用于班级多媒体屏幕的考试时间表的信息显示工具 tagline: 显示当前时间与考试详细信息的工具
actions: actions:
- text: 使用说明 - text: 使用说明
icon: lightbulb icon: lightbulb
@ -27,7 +27,7 @@ actions:
欢迎来到 ExamAware 的文档。 欢迎来到 ExamAware 的文档。
ExamAware 系列软件是显示当前时间与考试详细信息的显示工具,可以在各平台上运行。 ExamAware 系列软件是显示当前时间与考试详细信息的工具,可以在各平台上运行。
## 开始使用 ## 开始使用

View File

@ -1,9 +1,6 @@
# 客户端识别 # 客户端识别
您可以为每个 ExamAware 实例自定义一个 id来标识每个实例。您可以将自定义 id 设置为班级名、教室编号等易于识别的名称。 您可以为每个 ExamAware 实例自定义一个 id来标识每个实例。您可以将自定义 id 设置为班级名、教室编号等易于识别的名称。只有服务器段的 id 与客户端重复,客户端才能获得信息。
除了自定义的 id 外ExamAware 还会生成一段唯一客户端 idCUID来标识每个实例。
<a id="url-template"></a> <a id="url-template"></a>
@ -11,16 +8,10 @@
在调用集控清单中的 url 时ExamAware 可以根据客户端的信息,将对应信息填入 url 模板中,实现为每个 ExamAware 实例分配特定的对象。 在调用集控清单中的 url 时ExamAware 可以根据客户端的信息,将对应信息填入 url 模板中,实现为每个 ExamAware 实例分配特定的对象。
ExamAware 支持以下模板:
| 模板 | 说明 |
| -- | -- |
| `{id}` | 客户端的 ID |
| `{cuid}` | 客户端的唯一客户端 ID |
在发起请求时url 中的模板会直接被替换为对应信息,例如: 在发起请求时url 中的模板会直接被替换为对应信息,例如:
``` plaintext ``` plaintext
https://example.com/client/{id}/policy.json -> https://example.com/client/TEST_ID/policy.json http://localhost:3000/get_config.php?id={id} -> http://localhost:3000/get_config.php?id=111111
https://example.com/client/{cuid}/policy.json -> https://example.com/client/9f5ab079-83c7-aeba-db2f-db39a0009845/policy.json
``` ```
本文档尚未完工……