Skip to content

Commit

Permalink
docs(readme): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ysfscream authored and CrazyWisdom committed Dec 26, 2019
1 parent 9b827c4 commit b3d2ef3
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 18 deletions.
16 changes: 8 additions & 8 deletions README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

MQTTX 是 EMQ 开源的一款跨平台 MQTT 桌面客户端,它支持 macOS, Linux, Windows。

MQTTX 采用了聊天界面形式,简化了页面操作逻辑,允许在同一份 Broker 配置下保存多个客户端,方便用户快速测试 MQTT/MQTTS 连接,及 MQTT 消息的发布与订阅。
MQTTX 采用了聊天界面形式,简化了页面操作逻辑,允许保存多个客户端,方便用户快速测试 MQTT/MQTTS 连接,及 MQTT 消息的发布与订阅。

## 预览

Expand All @@ -24,18 +24,18 @@ MQTTX 采用了聊天界面形式,简化了页面操作逻辑,允许在同

## 使用

1. 首先创建一个 Broker
1. 创建一个连接,点击左侧菜单栏的 `+` 号按钮

```shell
# 如果你暂时没有一个可用的 MQTT Broker,你可以用这个 EMQ X 公共的 Broker 进行测试
2. 在表单中配置你所需要完成的项

> 如果你暂时没有一个可用的 MQTT Broker,你可以用这个 EMQ X 公共的 Broker 进行测试
```shell
Broker 地址: broker.emqx.io
Broker 端口: 1883
```

2. 同一个 Broker 下可以创建多个客户端

3. 回到连接页面,选择刚才创建的 Broker 下的客户端进行连接测试。或者你可以在客户端卡片上直接选择 `连接` 操作
3. 点击右上角的 `Connect` 按钮就可以快速的创建一个连接,并且对它进行一些消息测试了

## 开发

Expand Down Expand Up @@ -66,8 +66,8 @@ yarn run electron:build

## 技术栈

- [Vue](https://vuejs.org/) + [Element](https://element.eleme.io)
- [Electron](https://electronjs.org/)
- [Vue](https://vuejs.org/) + [Element](https://element.eleme.io)
- [TypeScript](https://www.typescriptlang.org/)
- [Lowdb](https://github.com/typicode/lowdb)

Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ English | [简体中文](./README-CN.md)

MQTTX is a cross-platform MQTT desktop client open sourced by EMQ, which supports macOS, Linux, and Windows.

MQTTX adopts the form of chat interface, which simplifies the page operation, allow multiple clients information to be saved under the same broker, facilitates the user to quickly test the MQTT/MQTTS connection, publish and subscribe to MQTT messages.
MQTTX adopts the form of chat interface, which simplifies the page operation, allow multiple clients information to be saved, facilitates the user to quickly test the MQTT/MQTTS connection, publish and subscribe to MQTT messages.

## Preview

Expand All @@ -24,18 +24,18 @@ Alternative, you can download [here](https://www.emqx.io/downloads/MQTTX/).

## Usage

1. Create broker
1. Create connection, click the `+` button on the left menu bar.

```shell
# If you don't have a mqtt broker available, you can use this EMQ X public broker to test.
2. Configure the items you need to complete in the form.

Broker Address: broker.emqx.io
Broker Port: 1883
```
> If you don't have a mqtt broker available, you can use this EMQ X public broker to test.
2. The same broker can create many clients
```shell
IP Address: broker.emqx.io
Port: 1883
```

3. Go back to connectons page, select the broker's client for connection testing. Or you can choose the `Connect` operation directly on the client card.
3. Click the `connect` button in the upper right corner and you can easily create a connection and test it with messages.

## Develop

Expand Down Expand Up @@ -66,8 +66,8 @@ yarn run electron:build

## Technology Stack

- [Vue](https://vuejs.org/) + [Element](https://element.eleme.io)
- [Electron](https://electronjs.org/)
- [Vue](https://vuejs.org/) + [Element](https://element.eleme.io)
- [TypeScript](https://www.typescriptlang.org/)
- [Lowdb](https://github.com/typicode/lowdb)

Expand Down
Binary file modified assets/mqttx-preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b3d2ef3

Please sign in to comment.