feat: README新增API服务器说明

mengguyi · Oct 24, 2023 · 3d0e66c · 3d0e66c
1 parent b9a9baf
commit 3d0e66c
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -290,6 +290,22 @@ BBDown -p ALL "https://www.bilibili.com/bangumi/play/ss33073"
 
 </details>
 
+<details>
+<summary>API服务器</summary>
+启动服务器（默认设置）
+```shell
+BBDown server
+```
+
+启动服务器（自定义监听地址和端口）：
+```shell
+BBDown server http://0.0.0.0:12450
+```
+API服务器不支持HTTPS配置，如果有需要请自行使用nginx等反向代理进行配置
+
+API详细请参考`json-api-doc.md`
+</details>
+
 # 演示
 ![1](https://user-images.githubusercontent.com/20772925/88686407-a2001480-d129-11ea-8aac-97a0c71af115.gif)