From 470490e15eecc7ee7b0a1c7806756a17e4298e39 Mon Sep 17 00:00:00 2001
From: yumoqing <yumoqing@gmail.com>
Date: Tue, 21 Jul 2026 17:38:21 +0800
Subject: [PATCH] docs: update README with API and deployment guide

---
 README.md | 35 ++++++++++++++++++++++++++++++++++-
 1 file changed, 34 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index b40bd78..a0e63a1 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,35 @@
-# graph-service
+# Graph Service — 图数据库服务
 
+## 概述
+
+基于 NetworkX 的内存图数据库服务，支持节点/边的增删查、邻居查询、路径搜索和图持久化。用于知识图谱的实体关系存储。
+
+## 后端
+
+NetworkX (纯 Python，无需外部依赖)
+
+## API
+
+| 端点 | 方法 | 说明 |
+|------|------|------|
+| /api/status | GET | 服务状态和图统计 |
+| /api/graph/add_node | POST | 添加节点 |
+| /api/graph/add_edge | POST | 添加边 |
+| /api/graph/neighbors | POST | 查询邻居 (支持深度) |
+| /api/graph/path | POST | 最短路径查询 |
+| /api/graph/query | POST | 通用图查询 |
+| /api/graph/stats | POST | 图统计信息 |
+| /api/graph/save | POST | 保存图到磁盘 |
+| /api/graph/load | POST | 从磁盘加载图 |
+
+## 部署
+
+```bash
+cd /data/ymq/graph-service
+bash build.sh
+sudo systemctl restart graph-service
+```
+
+## 端口
+
+9092