From 6652b57a0db575d30b6446ec85e0217848705133 Mon Sep 17 00:00:00 2001 From: Junyan Qin Date: Wed, 14 May 2025 16:08:34 +0800 Subject: [PATCH] doc: README --- README.md | 27 ++++++++++++++++----------- README_EN.md | 31 +++++++++++++++++-------------- README_JP.md | 31 +++++++++++++++++-------------- 3 files changed, 50 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index aa29179f..83e10c00 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ python [![star](https://gitcode.com/RockChinQ/LangBot/star/badge.svg)](https://gitcode.com/RockChinQ/LangBot) -[简体中文](README.md) / [English](README_EN.md) / [日本語](README_JP.md) +[简体中文](README.md) / [English](README_EN.md) / [日本語](README_JP.md) / (PR for your language) @@ -35,19 +35,23 @@ ## ✨ 特性 - 💬 大模型对话、Agent：支持多种大模型，适配群聊和私聊；具有多轮对话、工具调用、多模态能力，并深度适配 [Dify](https://dify.ai)。目前支持 QQ、QQ频道、企业微信、个人微信、飞书、Discord、Telegram 等平台。 -- 🛠️ 高稳定性、功能完备：原生支持访问控制、限速、敏感词过滤等机制；配置简单，支持多种部署方式。 +- 🛠️ 高稳定性、功能完备：原生支持访问控制、限速、敏感词过滤等机制；配置简单，支持多种部署方式。支持多流水线配置，不同机器人用于不同应用场景。 - 🧩 插件扩展、活跃社区：支持事件驱动、组件扩展等插件机制；适配 Anthropic [MCP 协议](https://modelcontextprotocol.io/)；目前已有数百个插件。 - 😻 Web 管理面板：支持通过浏览器管理 LangBot 实例，不再需要手动编写配置文件。 ## 📦 开始使用 -> [!IMPORTANT] -> -> 在您开始任何方式部署之前，请务必阅读[新手指引](https://docs.langbot.app/zh/insight/guide.html)。 - #### Docker Compose 部署 -适合熟悉 Docker 的用户，查看文档[Docker 部署](https://docs.langbot.app/zh/deploy/langbot/docker.html)。 +```bash +git clone https://github.com/RockChinQ/LangBot +cd LangBot +docker compose up -d +``` + +访问 http://localhost:5300 即可开始使用。 + +详细文档[Docker 部署](https://docs.langbot.app/zh/deploy/langbot/docker.html)。 #### 宝塔面板部署 @@ -69,13 +73,13 @@ ## 📸 效果展示 -bots +bots -bots +bots -bots +bots -bots +bots 回复效果（带有联网插件） @@ -116,6 +120,7 @@ | [xAI](https://x.ai/) | ✅ | | | [智谱AI](https://open.bigmodel.cn/) | ✅ | | | [PPIO](https://ppinfra.com/user/register?invited_by=QJKFYD&utm_source=github_langbot) | ✅ | 大模型和 GPU 资源平台 | +| [Google Gemini](https://aistudio.google.com/prompts/new_chat) | ✅ | | | [Dify](https://dify.ai) | ✅ | LLMOps 平台 | | [Ollama](https://ollama.com/) | ✅ | 本地大模型运行平台 | | [LMStudio](https://lmstudio.ai/) | ✅ | 本地大模型运行平台 | diff --git a/README_EN.md b/README_EN.md index 7c604da1..7e209f90 100644 --- a/README_EN.md +++ b/README_EN.md @@ -8,8 +8,8 @@ RockChinQ%2FLangBot | Trendshift Home ｜ -Deployment ｜ -Plugin ｜ +Deployment ｜ +Plugin ｜ Submit Plugin
@@ -24,7 +24,7 @@ [![GitHub release (latest by date)](https://img.shields.io/github/v/release/RockChinQ/LangBot)](https://github.com/RockChinQ/LangBot/releases/latest) python -[简体中文](README.md) / [English](README_EN.md) / [日本語](README_JP.md) +[简体中文](README.md) / [English](README_EN.md) / [日本語](README_JP.md) / (PR for your language)
@@ -33,31 +33,33 @@ ## ✨ Features - 💬 Chat with LLM / Agent: Supports multiple LLMs, adapt to group chats and private chats; Supports multi-round conversations, tool calls, and multi-modal capabilities. Deeply integrates with [Dify](https://dify.ai). Currently supports QQ, QQ Channel, WeCom, personal WeChat, Lark, DingTalk, Discord, Telegram, etc. -- 🛠️ High Stability, Feature-rich: Native access control, rate limiting, sensitive word filtering, etc. mechanisms; Easy to use, supports multiple deployment methods. +- 🛠️ High Stability, Feature-rich: Native access control, rate limiting, sensitive word filtering, etc. mechanisms; Easy to use, supports multiple deployment methods. Supports multiple pipeline configurations, different bots can be used for different scenarios. - 🧩 Plugin Extension, Active Community: Support event-driven, component extension, etc. plugin mechanisms; Integrate Anthropic [MCP protocol](https://modelcontextprotocol.io/); Currently has hundreds of plugins. - 😻 [New] Web UI: Support management LangBot instance through the browser. No need to manually write configuration files. ## 📦 Getting Started -> [!IMPORTANT] -> -> - Before you start deploying in any way, please read the [New User Guide](https://docs.langbot.app/zh/insight/guide.html). -> - All documentation is in Chinese, we will provide i18n version in the near future. -> - Read [the auto-generated wiki on DeepWiki](https://deepwiki.com/RockChinQ/LangBot). - #### Docker Compose Deployment -Suitable for users familiar with Docker, see the [Docker Deployment](https://docs.langbot.app/zh/deploy/langbot/docker.html) documentation. +```bash +git clone https://github.com/RockChinQ/LangBot +cd LangBot +docker compose up -d +``` + +Visit http://localhost:5300 to start using it. + +Detailed documentation [Docker Deployment](https://docs.langbot.app/en/deploy/langbot/docker.html). #### One-click Deployment on BTPanel -LangBot has been listed on the BTPanel, if you have installed the BTPanel, you can use the [document](https://docs.langbot.app/zh/deploy/langbot/one-click/bt.html) to use it. +LangBot has been listed on the BTPanel, if you have installed the BTPanel, you can use the [document](https://docs.langbot.app/en/deploy/langbot/one-click/bt.html) to use it. #### Zeabur Cloud Deployment Community contributed Zeabur template. -[![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/zh-CN/templates/ZKTBDH) +[![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/en-US/templates/ZKTBDH) #### Railway Cloud Deployment @@ -65,7 +67,7 @@ Community contributed Zeabur template. #### Other Deployment Methods -Directly use the released version to run, see the [Manual Deployment](https://docs.langbot.app/zh/deploy/langbot/manual.html) documentation. +Directly use the released version to run, see the [Manual Deployment](https://docs.langbot.app/en/deploy/langbot/manual.html) documentation. ## 📸 Demo @@ -116,6 +118,7 @@ Directly use the released version to run, see the [Manual Deployment](https://do | [Zhipu AI](https://open.bigmodel.cn/) | ✅ | | | [Dify](https://dify.ai) | ✅ | LLMOps platform | | [PPIO](https://ppinfra.com/user/register?invited_by=QJKFYD&utm_source=github_langbot) | ✅ | LLM and GPU resource platform | +| [Google Gemini](https://aistudio.google.com/prompts/new_chat) | ✅ | | | [Ollama](https://ollama.com/) | ✅ | Local LLM running platform | | [LMStudio](https://lmstudio.ai/) | ✅ | Local LLM running platform | | [GiteeAI](https://ai.gitee.com/) | ✅ | LLM interface gateway(MaaS) | diff --git a/README_JP.md b/README_JP.md index 304f8de5..f62970fc 100644 --- a/README_JP.md +++ b/README_JP.md @@ -8,8 +8,8 @@ RockChinQ%2FLangBot | Trendshift ホーム ｜ -デプロイ ｜ -プラグイン ｜ +デプロイ ｜ +プラグイン ｜ プラグインの提出
@@ -23,7 +23,7 @@ [![GitHub release (latest by date)](https://img.shields.io/github/v/release/RockChinQ/LangBot)](https://github.com/RockChinQ/LangBot/releases/latest) python -[简体中文](README.md) / [English](README_EN.md) / [日本語](README_JP.md) +[简体中文](README.md) / [English](README_EN.md) / [日本語](README_JP.md) / (PR for your language)
@@ -32,31 +32,33 @@ ## ✨ 機能 - 💬 LLM / エージェントとのチャット: 複数のLLMをサポートし、グループチャットとプライベートチャットに対応。マルチラウンドの会話、ツールの呼び出し、マルチモーダル機能をサポート。 [Dify](https://dify.ai) と深く統合。現在、QQ、QQ チャンネル、WeChat、個人 WeChat、Lark、DingTalk、Discord、Telegram など、複数のプラットフォームをサポートしています。 -- 🛠️ 高い安定性、豊富な機能: ネイティブのアクセス制御、レート制限、敏感な単語のフィルタリングなどのメカニズムをサポート。使いやすく、複数のデプロイ方法をサポート。 +- 🛠️ 高い安定性、豊富な機能: ネイティブのアクセス制御、レート制限、敏感な単語のフィルタリングなどのメカニズムをサポート。使いやすく、複数のデプロイ方法をサポート。複数のパイプライン設定をサポートし、異なるボットを異なる用途に使用できます。 - 🧩 プラグイン拡張、活発なコミュニティ: イベント駆動、コンポーネント拡張などのプラグインメカニズムをサポート。適配 Anthropic [MCP プロトコル](https://modelcontextprotocol.io/)；豊富なエコシステム、現在数百のプラグインが存在。 - 😻 Web UI: ブラウザを通じてLangBotインスタンスを管理することをサポート。 ## 📦 始め方 -> [!IMPORTANT] -> -> - どのデプロイ方法を始める前に、必ず[新規ユーザーガイド](https://docs.langbot.app/zh/insight/guide.html)をお読みください。 -> - すべてのドキュメントは中国語で提供されています。近い将来、i18nバージョンを提供する予定です。 -> - Read [the auto-generated wiki on DeepWiki](https://deepwiki.com/RockChinQ/LangBot)。 - #### Docker Compose デプロイ -Dockerに慣れているユーザーに適しています。[Dockerデプロイ](https://docs.langbot.app/zh/deploy/langbot/docker.html)のドキュメントを参照してください。 +```bash +git clone https://github.com/RockChinQ/LangBot +cd LangBot +docker compose up -d +``` + +http://localhost:5300 にアクセスして使用を開始します。 + +詳細なドキュメントは[Dockerデプロイ](https://docs.langbot.app/en/deploy/langbot/docker.html)を参照してください。 #### BTPanelでのワンクリックデプロイ -LangBotはBTPanelにリストされています。BTPanelをインストールしている場合は、[ドキュメント](https://docs.langbot.app/zh/deploy/langbot/one-click/bt.html)を使用して使用できます。 +LangBotはBTPanelにリストされています。BTPanelをインストールしている場合は、[ドキュメント](https://docs.langbot.app/en/deploy/langbot/one-click/bt.html)を使用して使用できます。 #### Zeaburクラウドデプロイ コミュニティが提供するZeaburテンプレート。 -[![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/zh-CN/templates/ZKTBDH) +[![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/en-US/templates/ZKTBDH) #### Railwayクラウドデプロイ @@ -64,7 +66,7 @@ LangBotはBTPanelにリストされています。BTPanelをインストール #### その他のデプロイ方法 -リリースバージョンを直接使用して実行します。[手動デプロイ](https://docs.langbot.app/zh/deploy/langbot/manual.html)のドキュメントを参照してください。 +リリースバージョンを直接使用して実行します。[手動デプロイ](https://docs.langbot.app/en/deploy/langbot/manual.html)のドキュメントを参照してください。 ## 📸 デモ @@ -114,6 +116,7 @@ LangBotはBTPanelにリストされています。BTPanelをインストール | [xAI](https://x.ai/) | ✅ | | | [Zhipu AI](https://open.bigmodel.cn/) | ✅ | | | [PPIO](https://ppinfra.com/user/register?invited_by=QJKFYD&utm_source=github_langbot) | ✅ | 大模型とGPUリソースプラットフォーム | +| [Google Gemini](https://aistudio.google.com/prompts/new_chat) | ✅ | | | [Dify](https://dify.ai) | ✅ | LLMOpsプラットフォーム | | [Ollama](https://ollama.com/) | ✅ | ローカルLLM実行プラットフォーム | | [LMStudio](https://lmstudio.ai/) | ✅ | ローカルLLM実行プラットフォーム |