Skip to content

Commit

Permalink
docs: update README to full english support
Browse files Browse the repository at this point in the history
  • Loading branch information
moonrailgun committed Feb 19, 2023
1 parent 751fb55 commit b6add42
Showing 1 changed file with 25 additions and 16 deletions.
41 changes: 25 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,32 +6,41 @@

![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 是一款现代化开源的即时通讯聊天应用,基于 React + Typescript 开发
Tailchat is a modern open source IM application which based on **React** + **Typescript**

前端微内核架构+后端微服务架构,Tailchat 已经为集群化部署做好了准备。
Front-end microkernel architecture + backend microservice architecture, `Tailchat` is ready for clustering deployment.

前端通过插件机制为应用赋能,对于 Tailchat 的二次开发来说非常简单且易用。
The front end empowers the application through the plugin system, which is very simple and easy to expand for the secondary development of `Tailchat`.

官方文档: [https://tailchat.msgbyte.com/](https://tailchat.msgbyte.com/)
Official Documentation: [https://tailchat.msgbyte.com/](https://tailchat.msgbyte.com/)

**Nightly版** 在线体验: [https://nightly.paw.msgbyte.com/](https://nightly.paw.msgbyte.com/)
**Nightly version** Try it online: [https://nightly.paw.msgbyte.com/](https://nightly.paw.msgbyte.com/)

> Nightly版 为自动编译版本, 即每次提交代码都会自动编译。
> 不保证数据的可靠性与稳定性
> Nightly version is the automatic compile version, that means, every commit code will be automatically compiled.
> The reliability and stability of the data are not guaranteed, you can deploy with stable version with docker images or github release page
**NOTICE: 虽然目前Tailchat的核心功能处于稳定阶段,但它对于第三方开发者暴露的接口仍在不断完善中,一般来说是向下兼容的,但保留出现 Break Change的可能性**
**NOTICE: Although the core functionality of Tailchat is currently in a stable stage, its exposed interface for third-party developers is still being improved. Generally speaking, it is backward compatible, but retains the possibility of Break Change**

## Feature

- 注重隐私,只有被邀请的成员才能加入群组
- 防止陌生人,只有通过昵称+一串随机的数字才能添加好友
- 二维的群组空间,通过频道来分割不同的话题
- 高度自定义的群组空间, 通过分组和拖拽来创建独创的群组空间。同时可以通过更多的插件来增加更多的能力
- 可以严谨,也可以乐趣。通过插件的组合可以创造用于不同场景的 Tailchat。可以是面向娱乐,也可以是面向企业
- 后端微服务架构,已经为大规模部署做好了准备。不用担心用户量大了以后怎么办
- Pay attention to privacy, only invited members can join the group
- Prevent strangers, add friends only by nickname + a random string of numbers
- Two-level group space, dividing different topics by panels
- Highly customized group space, create original group space by grouping with dragging and dropping. At the same time, more plugins can be used to add more capabilities
- It can be rigorous or fun. Through the combination of plugins, `Tailchat` can be created for different scenarios. It can be for individuals or for enterprises
- The backend microservice structure is ready for large-scale deployment. Don't worry about what to do after the number of user growth

## 交流

如果对 Tailchat 感兴趣,欢迎加入 Tailchat 的种子用户交流群,您的反馈可以帮助 Tailchat 更好的成长
Learn more in our [website](https://tailchat.msgbyte.com/)

## Communication

If you are interested in `Tailchat`, welcome to join `Tailchat`'s seed user exchange group, your feedback can help `Tailchat` grow better

### Tailchat

[Tailchat Nightly Group](https://nightly.paw.msgbyte.com/invite/8Jfm1dWb)

### Wechat

<img width="360" src="./website/static/img/wechat.jpg" />

0 comments on commit b6add42

Please sign in to comment.