Skip to content

Commit 3fb7da3

Browse files
committed
docs(readme): fix readme typo
1 parent bfbbebf commit 3fb7da3

File tree

2 files changed

+15
-58
lines changed

2 files changed

+15
-58
lines changed

README.md

Lines changed: 7 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66

77
MateChat React is the React version of [MateChat](https://github.com/DevCloudFE/MateChat), a front-end AI scenario solution UI library based on Huawei DevUI Design.
88

9-
109
[![npm Version](https://img.shields.io/npm/v/@matechat/react.svg)](https://www.npmjs.com/package/@matechat/react)
1110
[![npm Downloads](https://img.shields.io/npm/dm/@matechat/react.svg)](https://www.npmjs.com/package/@matechat/react)
1211
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
@@ -15,7 +14,7 @@ MateChat React is the React version of [MateChat](https://github.com/DevCloudFE/
1514

1615
<div align="center">
1716

18-
[English](./README.md) | [简体中文](./README.zh-CN.md)
17+
English | [简体中文](./README.zh-CN.md)
1918

2019
</div>
2120

@@ -48,8 +47,8 @@ pnpm add @matechat/react
4847
```
4948

5049
```tsx
51-
import { Bubble } from '@matechat/react';
52-
import avatar from './avatar.png';
50+
import { Bubble } from "@matechat/react";
51+
import avatar from "./avatar.png";
5352

5453
export default function BubbleDemo() {
5554
return (
@@ -73,33 +72,12 @@ export default function BubbleDemo() {
7372

7473
---
7574

76-
## Development
77-
78-
```bash
79-
git clone https://github.com/matechat/matechat-react.git
80-
cd matechat-react
81-
pnpm install
82-
pnpm dev
83-
```
84-
85-
Build the library:
86-
87-
```bash
88-
pnpm build
89-
```
90-
91-
---
92-
9375
## Documentation
9476

9577
The documentation is still in progress, but you can feel free to create a new issue in [GitCode](https://gitcode.com/DevCloudFE/MateChat/issues) or [GitHub](https://github.com/DevCloudFE/MateChat/issues) to submit your questions or suggestions. This project is still under development, so the documentation is not complete yet, some features may change in the future.
9678

9779
For more information, please track the progress in [#4](https://github.com/DevCloudFE/matechat-react/issues/4) and [#5](https://github.com/DevCloudFE/MateChat/issues/5).
9880

99-
100-
101-
102-
10381
## Star History
10482

10583
[![Star History Chart](https://api.star-history.com/svg?repos=DevCloudFE/matechat-react&type=Date)](https://www.star-history.com/#DevCloudFE/matechat-react&Date)
@@ -110,10 +88,9 @@ For more information, please track the progress in [#4](https://github.com/DevCl
11088

11189
We welcome all kinds of contributions:
11290

113-
* File issues for bugs or features
114-
* Create pull requests
115-
* Help with documentation or translations
116-
91+
- File issues for bugs or features
92+
- Create pull requests
93+
- Help with documentation or translations
11794

11895
**Contributors:**
11996

@@ -127,7 +104,7 @@ We welcome all kinds of contributions:
127104

128105
| MateChat React Chat Group | SOA Chat Group |
129106
| :------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------: |
130-
| [<img alt="MateChat React Chat Group" src="./assets/matechat-react-qq-group.jpg" />](https://qm.qq.com/q/aMLehEXzBm) | [<img alt="SOAt Chat Group" src="./assets/soa-qq-group.jpg" />](https://qm.qq.com/q/lOocKriX74) |
107+
| [<img alt="MateChat React Chat Group" src="./assets/matechat-react-qq-group.jpg" />](https://qm.qq.com/q/aMLehEXzBm) | [<img alt="SOA Chat Group" src="./assets/soa-qq-group.jpg" />](https://qm.qq.com/q/lOocKriX74) |
131108

132109
## License
133110

README.zh-CN.md

Lines changed: 8 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
MateChat React 是 [MateChat](https://github.com/DevCloudFE/MateChat) 的 React 版本,
88
它是一个基于华为 DevUI 设计的前端 AI 场景解决方案 UI 库。
99

10-
1110
[![npm Version](https://img.shields.io/npm/v/@matechat/react.svg)](https://www.npmjs.com/package/@matechat/react)
1211
[![npm Downloads](https://img.shields.io/npm/dm/@matechat/react.svg)](https://www.npmjs.com/package/@matechat/react)
1312
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
@@ -16,15 +15,15 @@ MateChat React 是 [MateChat](https://github.com/DevCloudFE/MateChat) 的 React
1615

1716
<div align="center">
1817

19-
[English](./README.md) | [简体中文](./README.zh-CN.md)
18+
[English](./README.md) | 简体中文
2019

2120
</div>
2221

2322
---
2423

2524
## 介绍
2625

27-
**MateChat React** 是一个专为 AI 场景打造的 React 组件库,适用于聊天助手、提示工程工具、Agent 框架等场景。 这是 [MateChat](https://github.com/DevCloudFE/MateChat) 的 React 版本,保持一致的功能与风格。
26+
**MateChat React** 是一个专为 AI 场景打造的 React 组件库,适用于聊天助手、提示工程工具、Agent 框架等场景。 这是 [MateChat](https://github.com/DevCloudFE/MateChat) 的 React 版本,保持一致的功能与风格。
2827

2928
MateChat 基于 [华为 DevUI Design](https://devui.design/),提供现代视觉语言、一致的用户体验以及良好的可扩展性。
3029

@@ -51,8 +50,8 @@ pnpm add @matechat/react
5150
```
5251

5352
```tsx
54-
import { Bubble } from '@matechat/react';
55-
import avatar from './avatar.png';
53+
import { Bubble } from "@matechat/react";
54+
import avatar from "./avatar.png";
5655

5756
export default function BubbleDemo() {
5857
return (
@@ -74,22 +73,6 @@ export default function BubbleDemo() {
7473
}
7574
```
7675

77-
78-
## 本地开发
79-
80-
```bash
81-
git clone https://github.com/matechat/matechat-react.git
82-
cd matechat-react
83-
pnpm install
84-
pnpm dev
85-
```
86-
87-
构建组件库:
88-
89-
```bash
90-
pnpm build
91-
```
92-
9376
---
9477

9578
## 文档
@@ -103,17 +86,17 @@ pnpm build
10386

10487
## Star 趋势
10588

106-
[![Star History Chart](https://api.star-history.com/svg?repos=DevCloudFE/matechat-react\&type=Date)](https://www.star-history.com/#DevCloudFE/matechat-react&Date)
89+
[![Star History Chart](https://api.star-history.com/svg?repos=DevCloudFE/matechat-react&type=Date)](https://www.star-history.com/#DevCloudFE/matechat-react&Date)
10790

10891
---
10992

11093
## 如何贡献
11194

11295
我们欢迎各种形式的贡献:
11396

114-
* 提交 bug 或需求 issue
115-
* 创建 pull request
116-
* 帮助完善文档或翻译
97+
- 提交 bug 或需求 issue
98+
- 创建 pull request
99+
- 帮助完善文档或翻译
117100

118101
**贡献者:**
119102

@@ -134,6 +117,3 @@ pnpm build
134117
## License
135118

136119
该项目已获得 [MIT 许可](./LICENSE).
137-
138-
139-

0 commit comments

Comments
 (0)