Update README
This commit is contained in:
CrazyWisdom
tigercl
parent
f238414826
commit
aaa2c48758
27
README-CN.md
27
README-CN.md
|
|
@ -7,8 +7,7 @@
|
|||
[](https://slack-invite.emqx.io)
|
||||
[](https://twitter.com/emqtt)
|
||||
|
||||
|
||||
[](https://www.emqx.io/cn/careers)
|
||||
[](https://www.emqx.io/cn/careers)
|
||||
|
||||
[English](./README.md) | 简体中文
|
||||
|
||||
|
|
@ -17,22 +16,24 @@
|
|||
从 3.0 版本开始，*EMQ X* 完整支持 MQTT V5.0 协议规范，向下兼容 MQTT V3.1 和 V3.1.1，并支持 MQTT-SN、CoAP、LwM2M、WebSocket 和 STOMP 等通信协议。EMQ X 3.0 单集群可支持千万级别的 MQTT 并发连接。
|
||||
|
||||
- 新功能的完整列表，请参阅 [EMQ X Release Notes](https://github.com/emqx/emqx/releases)。
|
||||
- 获取更多信息，请访问 [EMQ X](https://emqx.io)。
|
||||
- 获取更多信息，请访问 [EMQ X 官网](https://www.emqx.io/cn/)。
|
||||
|
||||
## 安装
|
||||
|
||||
*EMQ X* 是跨平台的，支持 Linux、Unix、Mac OS 以及 Windows。这意味着 *EMQ X* 可以部署在 x86_64 架构的服务器上，也可以部署在 Raspberry Pi 这样的 ARM 设备上。
|
||||
*EMQ X* 是跨平台的，支持 Linux、Unix、macOS 以及 Windows。这意味着 *EMQ X* 可以部署在 x86_64 架构的服务器上，也可以部署在 Raspberry Pi 这样的 ARM 设备上。
|
||||
|
||||
**使用 EMQ X Docker 镜像安装**
|
||||
#### EMQ X Docker 镜像安装
|
||||
|
||||
```
|
||||
docker run -d --name emqx -p 1883:1883 -p 8083:8083 -p 8883:8883 -p 8084:8084 -p 18083:18083 emqx/emqx
|
||||
```
|
||||
|
||||
**或者 [点此下载](https://emqx.io/downloads) 适合你的二进制软件包**
|
||||
#### 二进制软件包安装
|
||||
|
||||
- [单节点安装](https://docs.emqx.io/broker/v3/cn/install.html)
|
||||
- [集群安装](https://docs.emqx.io/broker/v3/cn/cluster.html)
|
||||
需从 [EMQ X 下载](https://www.emqx.io/cn/downloads) 页面获取相应操作系统的二进制软件包。
|
||||
|
||||
- [单节点安装文档](https://docs.emqx.io/broker/latest/cn/getting-started/install.html)
|
||||
- [集群配置文档](https://docs.emqx.io/broker/latest/cn/advanced/cluster.html)
|
||||
|
||||
## 从源码构建
|
||||
|
||||
|
|
@ -63,7 +64,7 @@ cd _rel/emqx && ./bin/emqx console
|
|||
|
||||
## FAQ
|
||||
|
||||
访问 [FAQ](https://docs.emqx.io/tutorial/v3/cn/faq/faq.html) 以获取常见问题的帮助。
|
||||
访问 [EMQ X FAQ](https://docs.emqx.io/broker/latest/cn/faq/faq.html) 以获取常见问题的帮助。
|
||||
|
||||
## 产品路线
|
||||
|
||||
|
|
@ -73,11 +74,13 @@ cd _rel/emqx && ./bin/emqx console
|
|||
|
||||
你可通过以下途径与 EMQ 社区及开发者联系:
|
||||
|
||||
- [EMQX Slack](http://emqx.slack.com)
|
||||
- [Slack](https://slack-invite.emqx.io)
|
||||
- [Twitter](https://twitter.com/emqtt)
|
||||
- [Forum](https://groups.google.com/d/forum/emqtt)
|
||||
- [Blog](https://medium.com/@emqtt)
|
||||
- [Facebook](https://www.facebook.com/emqxmqtt)
|
||||
- [Reddit](https://www.reddit.com/r/emqx/)
|
||||
- [Forum](https://groups.google.com/d/forum/emqtt)
|
||||
- [Weibo](https://weibo.com/emqtt)
|
||||
- [Blog](https://www.emqx.io/cn/blog)
|
||||
|
||||
欢迎你将任何 bug、问题和功能请求提交到 [emqx/emqx](https://github.com/emqx/emqx/issues)。
|
||||
|
||||
|
|
|
|||
24
README.md
24
README.md
|
|
@ -7,8 +7,7 @@
|
|||
[](https://slack-invite.emqx.io)
|
||||
[](https://twitter.com/emqtt)
|
||||
|
||||
|
||||
[](https://www.emqx.io/careers)
|
||||
[](https://www.emqx.io/careers)
|
||||
|
||||
English | [简体中文](./README-CN.md)
|
||||
|
||||
|
|
@ -17,22 +16,24 @@ English | [简体中文](./README-CN.md)
|
|||
Starting from 3.0 release, *EMQ X* broker fully supports MQTT V5.0 protocol specifications and backward compatible with MQTT V3.1 and V3.1.1, as well as other communication protocols such as MQTT-SN, CoAP, LwM2M, WebSocket and STOMP. The 3.0 release of the *EMQ X* broker can scaled to 10+ million concurrent MQTT connections on one cluster.
|
||||
|
||||
- For full list of new features, please read [EMQ X Release Notes](https://github.com/emqx/emqx/releases).
|
||||
- For more information, please visit [EMQ X homepage](https://emqx.io).
|
||||
- For more information, please visit [EMQ X homepage](https://www.emqx.io).
|
||||
|
||||
## Installation
|
||||
|
||||
The *EMQ X* broker is cross-platform, which supports Linux, Unix, Mac OS and Windows. It means *EMQ X* can be deployed on x86_64 architecture servers and ARM devices like Raspberry Pi.
|
||||
The *EMQ X* broker is cross-platform, which supports Linux, Unix, macOS and Windows. It means *EMQ X* can be deployed on x86_64 architecture servers and ARM devices like Raspberry Pi.
|
||||
|
||||
**Installing via EMQ X Docker Image**
|
||||
#### Installing via EMQ X Docker Image
|
||||
|
||||
```
|
||||
docker run -d --name emqx -p 1883:1883 -p 8083:8083 -p 8883:8883 -p 8084:8084 -p 18083:18083 emqx/emqx
|
||||
```
|
||||
|
||||
**Or download the binary package for your platform from [here](https://emqx.io/downloads).**
|
||||
#### Installing via Binary Package
|
||||
|
||||
- [Single Node Install](https://docs.emqx.io/broker/v3/en/install.html)
|
||||
- [Multi Node Install](https://docs.emqx.io/broker/v3/en/cluster.html)
|
||||
Get the binary package of the corresponding OS from [EMQ X Download](https://www.emqx.io/downloads) page.
|
||||
|
||||
- [Single Node Install](https://docs.emqx.io/broker/latest/en/getting-started/installation.html)
|
||||
- [Multi Node Install](https://docs.emqx.io/broker/latest/en/advanced/cluster.html)
|
||||
|
||||
|
||||
## Build From Source
|
||||
|
|
@ -65,7 +66,7 @@ To view the dashboard after running, use your browser to open: http://localhost:
|
|||
|
||||
## FAQ
|
||||
|
||||
Visiting [FAQ](https://docs.emqx.io/tutorial/v3/en/faq/faq.html) to get help of common problems.
|
||||
Visiting [EMQ X FAQ](https://docs.emqx.io/broker/latest/en/faq/faq.html) to get help of common problems.
|
||||
|
||||
## Roadmap
|
||||
|
||||
|
|
@ -74,11 +75,12 @@ The [EMQ X Roadmap uses Github milestones](https://github.com/emqx/emqx/mileston
|
|||
## Community, discussion, contribution, and support
|
||||
|
||||
You can reach the EMQ community and developers via the following channels:
|
||||
- [EMQX Slack](https://slack-invite.emqx.io/)
|
||||
- [Slack](https://slack-invite.emqx.io/)
|
||||
- [Twitter](https://twitter.com/emqtt)
|
||||
- [Facebook](https://www.facebook.com/emqxmqtt)
|
||||
- [Reddit](https://www.reddit.com/r/emqx/)
|
||||
- [Forum](https://groups.google.com/d/forum/emqtt)
|
||||
- [Blog](https://medium.com/@emqtt)
|
||||
- [Reddit](https://www.reddit.com/r/emqx/)
|
||||
|
||||
Please submit any bugs, issues, and feature requests to [emqx/emqx](https://github.com/emqx/emqx/issues).
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue