From e85a9e713eb79a594a5f2eec8cb5c8e2d7c3c845 Mon Sep 17 00:00:00 2001
From: weiaiweiai <59153123+weiaiweiai@users.noreply.github.com>
Date: Sun, 21 Sep 2025 17:01:53 +0800
Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=20README.md=20=E4=BB=A5?=
 =?UTF-8?q?=E6=B7=BB=E5=8A=A0=20NezhaAgentHTTPBridge=20=E8=AF=B4=E6=98=8E?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

添加了关于 NezhaAgentHTTPBridge 的功能、使用方法、API 接口、注意事项、错误代码及许可证信息的详细说明。内容涵盖了如何通过 HTTP 接口与 WebSocket 进行交互，并提供了相关的使用指导。
---
 README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..08210de
--- /dev/null
+++ b/README.md
@@ -0,0 +1,47 @@
+# NezhaAgentHTTPBridge
+
+�������Žӣ����� / �ۺ����� WebSocket ���͵ķ�����״̬���������һ�����ṩ HTTP �ӿ� `/WeatherForecast/lastws` ��ǰ����ѯ������������ǰ��չʾҳ `UI.html`��
+
+## ����ʹ��
+1. ������ˣ��ָ����������У���
+2. ʵ�ֻ���� WebSocket �����߼��������¼�� JSON д�� `WebSocketMessageStore`��
+3. ����/�� `UI.html`�������� `CFG.api` ��Ϊ���ʵ�ʵ�ַ��
+4. ǰ�˿�ʼ��ѯ��ʾ�ڵ�״̬��
+
+## �ӿ�
+- ·����`/WeatherForecast/lastws`
+- ���ã��������һ�� WebSocket ����ԭʼ JSON�������ݷ��� 404��
+- ֧�ֵ����� (`state + host`) ����㺬 `servers` / `list` / `data` ������ṹ��
+
+## ʹ��ʱע��
+- ��ַͬ��������·�ɻ���õ���·��ʱ��ͬ���޸�ǰ�� `CFG.api`��
+- ��ַ�޸ģ����޸�`WebSocketClientBackgroundService`�е� WebSocket ��ַ��
+- HTTPS��ҳ��Ϊ https ����ʹ�� https �ӿڣ�������������ء�
+- CORS�����������ں����ʽ������Դ����������ȫ���š�
+- �����ж������� `last_active` �� `offlineSec`��ʱ����ñ�׼ ISO8601 / UTC��
+- CPU ��ֵ��ǰ�˼ٶ���Χ 0�C100����ԭʼΪ 0�C1 ���Ȼ��㡣
+- �ֶ�������ȱʧ `state.*` �� `host.*` �����������������쳣����ʾ��
+- ��ѯƵ�ʣ�Ĭ�� 3000ms���ڵ���ӿ�ѹ����ʱ���Ӽ�������� ��2000ms����
+- ��ȫ���ƣ���Ҫʱ���ӷ���������� / Header Token / �������ʲ��ԡ�
+- �������ݣ��������ڲ� IP / ���ˣ�������ֱ�ӹ�����¶��
+- ��չ����
+  - ��ڵ㣺ʹ���ֵ䰴Ψһ ID �������״̬
+  - ��ʷ���ߣ����̻��λ���洢ʱ������
+  - Prometheus��ת���ֶε���ָ��
+  - ��ȡת�ƣ��ɸ��� SSE / WebSocket ���м�����ѯ
+  - �ֶ�ӳ�䣺����ͳһ�淶�㣬���ݲ�ͬ���θ�ʽ
+
+## ��������
+| ���� | ���� |
+|------|------|
+| 404 | ��δд���κ� WebSocket ���ݻ�·�ɲ���ȷ |
+| ���������ݡ� | ��黺��д���߼���ӿڷ����� |
+| CORS ���� | ���δ���ж�Ӧ Origin |
+| �������� | ʱ���ʽ���ɽ����������ʱ��Ư�� |
+| CPU/�ڴ���ʾ�쳣 | δͳһ��λ/�ٷֱȻ��� |
+
+## ����
+����ʹ�� MIT���������� LICENSE����
+
+## ��л
+��߸̽�뼰��ؿ�Դ��̬��
\ No newline at end of file