From 21e1acc4f5d1c4169bebd0826f40583125f2887a Mon Sep 17 00:00:00 2001 From: Junyan Qin Date: Tue, 4 Feb 2025 22:13:16 +0800 Subject: [PATCH] doc: add README_EN.md --- README.md | 5 ++- README_EN.md | 123 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 127 insertions(+), 1 deletion(-) create mode 100644 README_EN.md diff --git a/README.md b/README.md index 7dc489f7..fc78032c 100644 --- a/README.md +++ b/README.md @@ -26,11 +26,14 @@ [![GitHub release (latest by date)](https://img.shields.io/github/v/release/RockChinQ/LangBot)](https://github.com/RockChinQ/LangBot/releases/latest) ![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.qchatgpt.rockchin.top%2Fapi%2Fv2%2Fview%2Frealtime%2Fcount_query%3Fminute%3D10080&query=%24.data.count&label=%E4%BD%BF%E7%94%A8%E9%87%8F%EF%BC%887%E6%97%A5%EF%BC%89) python + +[简体中文](README.md) / [English](README_EN.md) +

-## ✨ Features +## ✨ 特性 - 💬 大模型对话、Agent：支持多种大模型，适配群聊和私聊；具有多轮对话、工具调用、多模态能力，并深度适配 [Dify](https://dify.ai)。目前支持 QQ、QQ频道、企业微信、飞书、Discord、个人微信，后续还将支持 WhatsApp、Telegram 等平台。 - 🛠️ 高稳定性、功能完备：原生支持访问控制、限速、敏感词过滤等机制；配置简单，支持多种部署方式。 diff --git a/README_EN.md b/README_EN.md new file mode 100644 index 00000000..fd266515 --- /dev/null +++ b/README_EN.md @@ -0,0 +1,123 @@ +

+ +LangBot + + +

+ +RockChinQ%2FQChatGPT | Trendshift + +Home ｜ +Features ｜ +Deployment ｜ +FAQ ｜ +Plugin ｜ +Submit Plugin + +
+😎High Stability, 🧩Extension Supported, 🦄Multi-modal - LLM Native Instant Messaging Bot Platform🤖 +
+ +
+ + + +[![GitHub release (latest by date)](https://img.shields.io/github/v/release/RockChinQ/LangBot)](https://github.com/RockChinQ/LangBot/releases/latest) + ![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.qchatgpt.rockchin.top%2Fapi%2Fv2%2Fview%2Frealtime%2Fcount_query%3Fminute%3D10080&query=%24.data.count&label=Usage(7days)) +python + +[简体中文](README.md) / [English](README_EN.md) + +
+ +

+ +## ✨ 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, Lark, Discord, personal WeChat, and will support WhatsApp, Telegram, etc. in the future. +- 🛠️ High Stability, Feature-rich: Native access control, rate limiting, sensitive word filtering, etc. mechanisms; Easy to use, supports multiple deployment methods. +- 🧩 Plugin Extension, Active Community: Support event-driven, component extension, etc. plugin mechanisms; Rich ecology, currently has dozens of [plugins](https://docs.langbot.app/plugin/plugin-intro.html) +- 😻 [New] Web UI: Support management LangBot instance through the browser, for details, see [documentation](https://docs.langbot.app/webui/intro.html) + +## 📦 Getting Started + +> [!IMPORTANT] +> +> - Before you start deploying in any way, please read the [New User Guide](https://docs.langbot.app/insight/guide.html). +> - All documentation is in Chinese, we will provide i18n version in the near future. + +#### Docker Compose Deployment + +Suitable for users familiar with Docker, see the [Docker Deployment](https://docs.langbot.app/deploy/langbot/docker.html) documentation. + +#### 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/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) + +#### Railway Cloud Deployment + +[![Deploy on Railway](https://railway.com/button.svg)](https://railway.app/template/yRrAyL?referralCode=vogKPF) + +#### Other Deployment Methods + +Directly use the released version to run, see the [Manual Deployment](https://docs.langbot.app/deploy/langbot/manual.html) documentation. + +## 📸 Demo + +Reply Effect (with Internet Plugin) + +- WebUI Demo: https://demo.langbot.dev/ + - Login information: Email: `demo@langbot.app` Password: `langbot123456` + - Note: Only the WebUI effect is shown, please do not fill in any sensitive information in the public environment. + +## 🔌 Component Compatibility + +### Message Platform + +| Platform | Status | Remarks | +| --- | --- | --- | +| Personal QQ | ✅ | | +| QQ Official API | ✅ | | +| WeCom | ✅ | | +| Lark | ✅ | | +| Discord | ✅ | | +| Personal WeChat | ✅ | Use [Gewechat](https://github.com/Devo919/Gewechat) to access | +| Telegram | 🚧 | | +| WhatsApp | 🚧 | | +| DingTalk | 🚧 | | + +🚧: In development + +### LLMs + +| LLM | Status | Remarks | +| --- | --- | --- | +| [OpenAI](https://platform.openai.com/) | ✅ | Available for any OpenAI interface format model | +| [DeepSeek](https://www.deepseek.com/) | ✅ | | +| [Moonshot](https://www.moonshot.cn/) | ✅ | | +| [Anthropic](https://www.anthropic.com/) | ✅ | | +| [xAI](https://x.ai/) | ✅ | | +| [Zhipu AI](https://open.bigmodel.cn/) | ✅ | | +| [Dify](https://dify.ai) | ✅ | LLMOps platform | +| [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) | +| [SiliconFlow](https://siliconflow.cn/) | ✅ | LLM gateway(MaaS) | +| [Aliyun Bailian](https://bailian.console.aliyun.com/) | ✅ | LLM gateway(MaaS) | + +## 🤝 Community Contribution + +Thanks to the following contributors and everyone in the community for their contributions. + + + + + + +