更新文档

ikenxuan · Aug 8, 2024 · 70959e2 · 70959e2
1 parent 02d95d5
commit 70959e2
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 3 deletions.
diff --git a/docs/intro/apiserver.md b/docs/intro/apiserver.md
@@ -1,4 +1,9 @@
 # 本地视频解析 API 服务
+::: warning
+**🚧该功能正在开发中，存在各种不稳定性**
+
+版本迭代可能过快
+:::
 
 该功能通过配置文件 `app.yaml` 进行管理
 
@@ -10,8 +15,22 @@ APIServer: true
 APIServerPort: 4567
 ```
 
-API 文档请查看 [**Apifox**](https://amagi.apifox.cn)
+🛰️ API 文档请查看 [**Apifox**](https://amagi.apifox.cn)
+
+## 📦 调用解析包
+>💡 npmjs: https://www.npmjs.com/package/@ikenxuan/amagi
+
+安装解析包: `pnpm install @ikenxuan/amagi`
 
+```js
+import amagi, { StartClient } from '@ikenxuan/amagi'
 
-## TODO
-- [x] API 文档 
+// 初始化
+const client = await new amagi({
+  douyin: '抖音ck',
+  bilibili: 'B站ck'
+}).initServer(true) // 传入 true 则开启日志
+
+// 启动监听
+await StartClient(client, { port: 4567 })
+```
diff --git a/docs/start/start.md b/docs/start/start.md
@@ -49,6 +49,7 @@ _**这是一个基于 [抖音](https://www.douyin.com)、[bilibili](https://www.
 - [SocialSisterYi/bilibili-API-collect](https://github.com/SocialSisterYi/bilibili-API-collect)
 - [NearHuiwen/TiktokDouyinCrawler](https://github.com/NearHuiwen/TiktokDouyinCrawler)
 - [B1gM8c/X-Bogus](https://github.com/B1gM8c/X-Bogus)
+- [ikenxuan/amagi](https://github.com/ikenxuan/amagi)
 
 **友情链接**