From e6d5b8e8883b2f1125d79f52bae4218ff1ac66de Mon Sep 17 00:00:00 2001
From: yumoqing <yumoqing@gmail.com>
Date: Tue, 21 Jul 2026 17:38:20 +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 0a7e8de..acafe49 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,35 @@
-# face-service
+# Face Service — 人脸识别服务
 
+## 概述
+
+基于 InsightFace (buffalo_l) 的人脸检测与识别服务，部署于 GPU 服务器，提供人脸检测、特征提取、1:1 比对、1:N 识别 API。
+
+## 模型
+
+- InsightFace buffalo_l (检测 + 识别)
+- 检测尺寸: 640×640
+- 特征维度: 512
+
+## API
+
+| 端点 | 方法 | 说明 |
+|------|------|------|
+| /api/status | GET | 服务状态和模型信息 |
+| /api/detect | POST | 人脸检测 (返回 bbox + 关键点) |
+| /api/recognize | POST | 人脸识别 (返回特征向量 + 匹配身份) |
+| /api/compare | POST | 1:1 比对 (两张人脸 → 相似度) |
+| /api/face-detect | POST | 别名: 同 /api/detect |
+| /api/face-recognize | POST | 别名: 同 /api/recognize |
+| /api/face-compare | POST | 别名: 同 /api/compare |
+
+## 部署
+
+```bash
+cd /data/ymq/face-service
+bash build.sh
+sudo systemctl restart face-service
+```
+
+## 端口
+
+9091