diff --git a/README.md b/README.md index a29544243..d9119724b 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,7 @@ environment that starts DSH (for DeepSeek: `DEEPSEEK_API_KEY`). Each Bot can use ### 5. Connect Bot Social (for friends' Bots) -`@flybot/social` stays idle until it knows a Bot Social server. Add this to +`@flybot/social` talks to a [Bot Social](https://github.com/Birfy/bot-social) server that you self-host (see its README for setup). It stays idle until it knows a Bot Social server. Add this to `~/.dsh/profiles/web/cordis.patch.yml`, then restart DSH: ```yaml diff --git a/README.zh.md b/README.zh.md index f5b384bc3..1d8ffdccc 100644 --- a/README.zh.md +++ b/README.zh.md @@ -122,7 +122,7 @@ FlyBot = FlyBot(`core/`)+ 功能插件。扩展接口由 ds-bot 自己提供 需要 Node.js >= 22.19 和 pnpm。先把 ds-bot 和两个插件加入 DSH profile:在 `core/` 下运行 `npm run install:doctor` 检查 Node 版本和三个包是否齐全,并打印下面的命令,再在该 profile 的 -`cordis.patch.yml` 里启用(social 需要填 Bot Social 服务器地址): +`cordis.patch.yml` 里启用(social 需要填 Bot Social 服务器地址)。social 插件连接的是你自行部署的 [Bot Social](https://github.com/Birfy/bot-social) 服务器,部署方法见其 README: ```sh npx @deepseek-ai/dsh plugin --profile web add "github:ThinkFlowLab/FlyBot#main&path:/core" diff --git a/docs/subsystems/social.md b/docs/subsystems/social.md index 2ba90c0fa..3d0d2b5e9 100644 --- a/docs/subsystems/social.md +++ b/docs/subsystems/social.md @@ -6,6 +6,8 @@ owned_paths: # social (`@flybot/social`) +The social plugin talks to a [Bot Social](https://github.com/Birfy/bot-social) server that you self-host. See the Bot Social README for install and configuration. + Bot Social plugin for chatting with friends' Bots (send middleware `social` with per-home approval) lives entirely under `plugins/social/`. ## Owns diff --git a/plugins/social/README.md b/plugins/social/README.md index 8f8a44b2a..e64883500 100644 --- a/plugins/social/README.md +++ b/plugins/social/README.md @@ -1,6 +1,6 @@ # flybot-social -Every local Bot can chat with friends' Bots on a Bot Social server. Host: `index.js`; +Every local Bot can chat with friends' Bots on a [Bot Social](https://github.com/Birfy/bot-social) server. The plugin talks to a Bot Social server that you self-host; see the Bot Social README for install and configuration. Host: `index.js`; browser: `client.js`. Design: see "Social design: homes and members" in the root README. - **One-click onboarding**: on first start, `POST /v1/onboard/flybot` creates the