Skip to content

开源白板工具(SaaS),一体化白板,包含思维导图、流程图、自由画等。All in one open-source whiteboard tool with mind, flowchart, freehand and etc.

build: improve README

pubuzhixing861dbd522b10b
diff --git a/README.md b/README.md
index e60160d..9316f07 100644
--- a/README.md
+++ b/README.md
@@ -20,7 +20,7 @@
[*English README*](https://github.com/plait-board/drawnix/blob/develop/README_en.md)
-# 特性
+## 特性
- 💯 免费 + 开源
- ⚒️ 思维导图、流程图
@@ -34,7 +34,7 @@
- 📱 移动设备适配
-# 关于名称
+## 关于名称
***Drawnix*** ,源于绘画( ***Draw*** )与凤凰( ***Phoenix*** )的灵感交织。
@@ -45,23 +45,21 @@
*Draw Beyond, Rise Above.*
-# 与 Plait 画图框架
+## 与 Plait 画图框架
*Drawnix* 的定位是一个开箱即用、开源、免费的工具产品,它的底层是 *Plait* 框架,*Plait* 是我司开源的一款画图框架,代表着公司在知识库产品上的重要技术沉淀。
Drawnix 是插件架构,与前面说到开源工具比技术架构更复杂一些,但是插件架构也有优势,比如能够支持多种 UI 框架(*Angular、React*),能够集成不同富文本框架(当前仅支持 *Slate* 框架),在开发上可以很好的实现业务的分层,开发各种细粒度的可复用插件,可以扩展更多的画板的应用场景。
-# drawnix.com
+## 应用
-https://drawnix.com,是 *drawnix* 的最小化应用。
+[*https://drawnix.com*](https://drawnix.com) 是 *drawnix* 的最小化应用。
-近期我会高频迭代 [drawnix.com](https://drawnix.com),直到发布 *Dawn* 版本。
-
-*欢迎大家 star ⭐️⭐️⭐️ 支持。*
+近期会高频迭代 drawnix.com,直到发布 *Dawn* 版本。
-# 开发
+## 开发
```
npm install
@@ -69,7 +67,7 @@ npm install
npm run start
```
-# 依赖
+## 依赖
- [plait](https://github.com/worktile/plait) - 画图框架
- [slate](https://github.com/ianstormtaylor/slate) - 富文本编辑器框架
@@ -77,7 +75,7 @@ npm run start
-# 贡献
+## 贡献
欢迎任何形式的贡献:
@@ -85,7 +83,11 @@ npm run start
- 贡献代码
+## 支持
+
+*欢迎大家 star ⭐️⭐️⭐️ 支持。*
+
-# License
+## License
[MIT License](https://github.com/plait-board/drawnix/blob/master/LICENSE)
\ No newline at end of file
diff --git a/README_en.md b/README_en.md
index a838b0a..6e7551b 100644
--- a/README_en.md
+++ b/README_en.md
@@ -18,9 +18,9 @@
</figure>
</div>
-[*中文文档*](https://github.com/plait-board/drawnix/blob/develop/README.md)
+[*中文*](https://github.com/plait-board/drawnix/blob/develop/README.md)
-# Features
+## Features
- 💯 Free and Open Source
- ⚒️ Mind Maps and Flowcharts
@@ -34,7 +34,7 @@
- 📱 Mobile-friendly
-# About the Name
+## About the Name
***Drawnix*** is born from the interweaving of ***Draw*** and ***Phoenix***, a fusion of artistic inspiration.
@@ -44,23 +44,21 @@ Like a Phoenix, creativity must rise from the flames to be reborn, and ***Drawni
*Draw Beyond, Rise Above.*
-# About Plait Drawing Framework
+## About Plait Drawing Framework
*Drawnix* is positioned as an out-of-the-box, *open-source*, and free tool product. It is built on top of the *Plait* framework, which is our company's *open-source* drawing framework representing significant technical accumulation in knowledge base products.
*Drawnix* uses a *plugin architecture*, which is technically more complex than the previously mentioned *open-source* tools. However, this *plugin architecture* has its advantages: it supports multiple *UI frameworks* (*Angular*, *React*), integrates with different *rich text frameworks* (currently only supporting *Slate* framework), enables better business layer separation in development, allows development of various fine-grained reusable plugins, and can expand to more whiteboard application scenarios.
-# drawnix.com
+## Try It Out
*https://drawnix.com* is the minimal application of *drawnix*.
I will be iterating frequently on *drawnix.com* until the release of the *Dawn* version.
-*Please show your support by giving us a star ⭐️⭐️⭐️.*
-
-# Development
+## Development
```
npm install
@@ -68,14 +66,14 @@ npm install
npm run start
```
-# Dependencies
+## Dependencies
- [plait](https://github.com/worktile/plait) - Drawing framework
- [slate](https://github.com/ianstormtaylor/slate) - Rich text editor framework
- [floating-ui](https://github.com/floating-ui/floating-ui) - An awesome library for creating floating UI elements
-# Contributing
+## Contributing
Any form of contribution is welcome:
@@ -83,7 +81,10 @@ Any form of contribution is welcome:
- Contribute code
+## Support Us
+
+*Please show your support by giving us a star ⭐️⭐️⭐️.*
-# License
+## License
[MIT License](https://github.com/plait-board/drawnix/blob/master/LICENSE)
\ No newline at end of file