Skip to content

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

chore: update README (#21)

pubuzhixing894c2cfffabfb
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..fcfa849
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Drawnix
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
index 7d2b597..da60516 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,57 @@
# Drawnix
-All in on open-source whiteboard app with mind, flowchart, and freehand.
+开源白板工具([drawnix.com](https://drawnix.com)),一体化白板,包含思维导图、流程图等。
-# Development
+---
+
+***Drawnix*** ,源于绘画( ***Draw*** )与凤凰( ***Phoenix*** )的灵感交织。
+
+凤凰象征着生生不息的创造力,而 Draw 代表着人类最原始的表达方式。在这里,每一次创作都是一次艺术的涅槃,每一笔绘画都是灵感的重生。
+
+创意如同凤凰,浴火方能重生,而 ***Drawnix*** 愿做技术与创意之火的守护者。
+
+*Draw Beyond, Rise Above.*
+
+# 特性
+
+- 💯 免费 + 开源
+- ⚒️ 思维导图、流程图
+- 😀 插入 Iconfont 表情(🚧 支持中...)
+- 🚀 基于插件机制 - 可灵活扩展
+- 🖼️ 📃 导出为 PNG, JPG, JSON(`.drawnix`)
+- 💾 自动保存(浏览器缓存)
+- 编辑特性:撤销、重做、复制、粘贴等
+- 无限画布:缩放、滚动、
+- 🎨 主题模式(🚧 支持中...)
+
+
+
+
+# 与 Plait 画图框架
+
+Drawnix 是上层的白板工具组件、产品,它的底层是 Plait 框架,Plait 是我司开源的一款画图框架,是一款可以灵活扩展的画图框架,代表着公司在知识库产品上的重要技术沉淀,自上线 2 年多的时间已经服务超过 6000+ 的研发赛道企业。
+
+Drawnix 是想在 Plait 的基础上更多的融合社区的产品思路、技术思路、交互灵感等,为大家提供一个真正简单好用的画图工具。
+
+我们公司前端的技术栈是 Angular,Plait 框架最初的版本也是与 Angular 框架绑定的,后来为了更好的适应开源社区,我们将 Plait 逐步改造为无框架依赖架构,Drawnix 也是在这基础上产生的,Drawnix 底层依赖 Plait 的插件机制、UI 上结合 React 及其生态,代表着除了我司主线知识库产品的另外一个重要的应用场景。
+
+# 开发
```
npm install
npm run start
-```
\ No newline at end of file
+```
+
+# 贡献
+
+欢迎任何形式的贡献:
+
+- 提 Bug
+
+- 贡献代码
+
+
+# License
+
+[MIT License](https://github.com/plait-board/drawnix/blob/master/LICENSE)
\ No newline at end of file