From ba16ff6cb13291a7f71528082937c509d8657417 Mon Sep 17 00:00:00 2001 From: moonrailgun Date: Tue, 28 Feb 2023 16:54:46 +0800 Subject: [PATCH] docs: add chinese README and remove wechat qrcode in en README --- README.md | 6 ++---- README.zh.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 45 insertions(+), 4 deletions(-) create mode 100644 README.zh.md diff --git a/README.md b/README.md index 9d00864d..d37a7a9e 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ ![tailchat](https://socialify.git.ci/msgbyte/tailchat/image?description=1&font=Inter&forks=1&issues=1&language=1&logo=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F86033898%3Fs%3D200%26v%3D4&name=1&owner=1&pattern=Circuit%20Board&stargazers=1&theme=Light) +[简体中文](./README.zh.md) + Tailchat is a modern open source IM application which based on **React** + **Typescript** Front-end microkernel architecture + backend microservice architecture, `Tailchat` is ready for clustering deployment. @@ -40,7 +42,3 @@ If you are interested in `Tailchat`, welcome to join `Tailchat`'s seed user exch ### Tailchat [Tailchat Nightly Group](https://nightly.paw.msgbyte.com/invite/8Jfm1dWb) - -### Wechat - - diff --git a/README.zh.md b/README.zh.md new file mode 100644 index 00000000..fc31e1c3 --- /dev/null +++ b/README.zh.md @@ -0,0 +1,43 @@ +# Tailchat + +[![Docker Publish](https://github.com/msgbyte/tailchat/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/msgbyte/tailchat/actions/workflows/docker-publish.yml) +![Docker Image Version (tag latest semver)](https://img.shields.io/docker/v/moonrailgun/tailchat/latest) +![Docker Pulls](https://img.shields.io/docker/pulls/moonrailgun/tailchat) + +![tailchat](https://socialify.git.ci/msgbyte/tailchat/image?description=1&font=Inter&forks=1&issues=1&language=1&logo=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F86033898%3Fs%3D200%26v%3D4&name=1&owner=1&pattern=Circuit%20Board&stargazers=1&theme=Light) + + +前端微内核架构+后端微服务架构，Tailchat 已经为集群化部署做好了准备。 + +前端通过插件机制为应用赋能，对于 Tailchat 的二次开发来说非常简单且易用。 + +官方文档: [https://tailchat.msgbyte.com/](https://tailchat.msgbyte.com/) + +**Nightly版** 在线体验: [https://nightly.paw.msgbyte.com/](https://nightly.paw.msgbyte.com/) + +> Nightly版 为自动编译版本, 即每次提交代码都会自动编译。 +> 不保证数据的可靠性与稳定性 + +**NOTICE: 虽然目前Tailchat的核心功能处于稳定阶段，但它对于第三方开发者暴露的接口仍在不断完善中，一般来说是向下兼 +容的，但保留出现 Break Change的可能性** + +## Feature + +- 注重隐私，只有被邀请的成员才能加入群组 +- 防止陌生人，只有通过昵称+一串随机的数字才能添加好友 +- 二维的群组空间，通过频道来分割不同的话题 +- 高度自定义的群组空间, 通过分组和拖拽来创建独创的群组空间。同时可以通过更多的插件来增加更多的能力 +- 可以严谨，也可以乐趣。通过插件的组合可以创造用于不同场景的 Tailchat。可以是面向娱乐，也可以是面向企业 +- 后端微服务架构，已经为大规模部署做好了准备。不用担心用户量大了以后怎么办 + +## 交流 + +如果对 Tailchat 感兴趣，欢迎加入 Tailchat 的种子用户交流群，您的反馈可以帮助 Tailchat 更好的成长 + +### 社区 + +[Tailchat Nightly Group](https://nightly.paw.msgbyte.com/invite/8Jfm1dWb) + +### 微信 + +