Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
moonrailgun committed Mar 8, 2023
1 parent b906af4 commit 8add6f3
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 13 deletions.
35 changes: 31 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@

[简体中文](./README.zh.md)

Tailchat is a modern open source IM application which based on **React** + **Typescript**
## Next generation noIM application in your own workspace

Front-end microkernel architecture + backend microservice architecture, `Tailchat` is ready for clustering deployment.
### Not only another `Slack`, `Discord`, `Rocket.Chat`....

The front end empowers the application through the plugin system, which is very simple and easy to expand for the secondary development of `Tailchat`.
If you are interested in the concept of `noIM`, welcome to read my blog:
- [It's time to officially step into the era of noIM](https://tailchat.msgbyte.com/blog/2023/03/01/the-era-of-noIM)

Official Documentation: [https://tailchat.msgbyte.com/](https://tailchat.msgbyte.com/)

Expand All @@ -21,7 +22,13 @@ Official Documentation: [https://tailchat.msgbyte.com/](https://tailchat.msgbyte
> 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: 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**
## Motivation

At present, the existing IM applications only focus on chatting itself, and IM is naturally a multi-person collaboration method. In my opinion, it should be able to take on more responsibilities, and form its own unique way of forwarding external applications through IM workflow.

Therefore, I bring up the point of `noIM`, which means **Not only IM**. Instead, it designed a highly customized application platform for individuals/teams centered on IM, with third-party applications as enhanced functions, and a plugin system as the glue connection layer in the middle.

To this end, the functions were abstracted, and a lot of time was spent designing the underlying mechanism. An instant messaging application such as `Tailchat` was born for expansion from the beginning of the underlying design. Through `Tailchat`'s plugin system, developers can easily use their favorite applications as part of `Tailchat` in a very natural way. Different from traditional integration methods such as `Slack`, the integration of `Tailchat` is more free, as if it is a native function.

## Feature

Expand All @@ -34,6 +41,26 @@ Official Documentation: [https://tailchat.msgbyte.com/](https://tailchat.msgbyte

Learn more in our [website](https://tailchat.msgbyte.com/)

## Performance and Expansion

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.

The front end empowers the application through the plugin system, which is very simple and easy to expand for the secondary development of `Tailchat`.

**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**

## Preview

![](./website/static/img/intro/hello.png)

![](./website/static/img/intro/plugins.png)

![](./website/static/img/intro/roles.png)

Visit the official website to learn more: [https://tailchat.msgbyte.com/](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
Expand Down
47 changes: 38 additions & 9 deletions README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,58 @@
![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 的二次开发来说非常简单且易用。

## 在您自己工作区中的下一代 noIM 应用程序

### 不仅仅是另一个 `Slack`, `Discord`, `Rocket.Chat`....

如果您对`noIM`的概念感兴趣,欢迎阅读我的博客:
- [是时候正式步入noIM的时代了](https://tailchat.msgbyte.com/zh-Hans/blog/2023/03/01/the-era-of-noIM)

官方文档: [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
## 动机

目前现有的IM应用都仅仅把目光局限在聊天本身,而IM天然作为一个多人协作方式,在我看来应当能够承担更多的职责,将外部的应用以IM为转发方式形成自己独特的工作流。

因此,我提出了 `noIM` 的观点,意味着 **Not only IM**。而是设计了以IM为中心,第三方应用为增强功能,中间以插件系统作为胶水连接层的个人/团队高度自定义的应用平台。

为此,将功能进行抽象,并且花费了大量时间设计底层的机制,诞生了 `Tailchat` 这样的一个从底层设计之初就为了拓展而存在的即时通讯应用。通过`Tailchat`的插件系统,开发者可以很轻松的将喜欢的应用以一种非常自然的方式作为`Tailchat`的一部分。与传统的类似如`Slack`的集成方式不同的是,`Tailchat`的集成更加自由,就仿佛天然就是一个原生的功能一般。

## 特性

- 注重隐私,只有被邀请的成员才能加入群组
- 防止陌生人,只有通过昵称+一串随机的数字才能添加好友
- 二维的群组空间,通过频道来分割不同的话题
- 高度自定义的群组空间, 通过分组和拖拽来创建独创的群组空间。同时可以通过更多的插件来增加更多的能力
- 可以严谨,也可以乐趣。通过插件的组合可以创造用于不同场景的 Tailchat。可以是面向娱乐,也可以是面向企业
- 后端微服务架构,已经为大规模部署做好了准备。不用担心用户量大了以后怎么办

## 性能与拓展

`Tailchat` 是一个基于 **React** + **Typescript** 的现代开源 noIM 应用程序

前端微内核架构+后端微服务架构,`Tailchat` 已经为集群化部署做好了准备。

前端通过插件机制为应用赋能,对于 `Tailchat` 的二次开发来说非常简单且易用。

**NOTICE: 虽然目前`Tailchat`的核心功能处于稳定阶段,但它对于第三方开发者暴露的接口仍在不断完善中,一般来说是向下兼
容的,但保留出现 `Break Change`的可能性**

## 预览

![](./website/static/img/intro/hello.png)

![](./website/static/img/intro/plugins.png)

![](./website/static/img/intro/roles.png)

访问官方网站了解更多: [https://tailchat.msgbyte.com/](https://tailchat.msgbyte.com/)

## 交流

如果对 Tailchat 感兴趣,欢迎加入 Tailchat 的种子用户交流群,您的反馈可以帮助 Tailchat 更好的成长
Expand Down

0 comments on commit 8add6f3

Please sign in to comment.