Skip to content

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

build: add README_en (#31)

pubuzhixing803880eb92769
diff --git a/README.md b/README.md
index db76ffa..e60160d 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
<div align="center">
<h2>
- 开源白板工具(SAAS),一体化白板,包含思维导图、流程图等
+ 开源白板工具(SaaS),一体化白板,包含思维导图、流程图等
<br />
</h2>
</div>
@@ -18,6 +18,8 @@
</figure>
</div>
+[*English README*](https://github.com/plait-board/drawnix/blob/develop/README_en.md)
+
# 特性
- 💯 免费 + 开源
@@ -36,7 +38,7 @@
***Drawnix*** ,源于绘画( ***Draw*** )与凤凰( ***Phoenix*** )的灵感交织。
-凤凰象征着生生不息的创造力,而 Draw 代表着人类最原始的表达方式。在这里,每一次创作都是一次艺术的涅槃,每一笔绘画都是灵感的重生。
+凤凰象征着生生不息的创造力,而 *Draw* 代表着人类最原始的表达方式。在这里,每一次创作都是一次艺术的涅槃,每一笔绘画都是灵感的重生。
创意如同凤凰,浴火方能重生,而 ***Drawnix*** 要做技术与创意之火的守护者。
@@ -45,15 +47,18 @@
# 与 Plait 画图框架
-Drawnix 是上层的白板工具组件、产品,它的底层是 Plait 框架,Plait 是我司开源的一款画图框架,是一款可以灵活扩展的画图框架,代表着公司在知识库产品上的重要技术沉淀,自上线 2 年多的时间已经服务超过 6000+ 的研发赛道企业。
+*Drawnix* 的定位是一个开箱即用、开源、免费的工具产品,它的底层是 *Plait* 框架,*Plait* 是我司开源的一款画图框架,代表着公司在知识库产品上的重要技术沉淀。
+
+
+Drawnix 是插件架构,与前面说到开源工具比技术架构更复杂一些,但是插件架构也有优势,比如能够支持多种 UI 框架(*Angular、React*),能够集成不同富文本框架(当前仅支持 *Slate* 框架),在开发上可以很好的实现业务的分层,开发各种细粒度的可复用插件,可以扩展更多的画板的应用场景。
-Drawnix 是想在 Plait 的基础上更多的融合社区的产品思路、技术思路、交互灵感等,为大家提供一个真正简单好用的画图工具。
+# drawnix.com
-我们公司前端的技术栈是 Angular,Plait 框架最初的版本也是与 Angular 框架绑定的,后来为了的提升 Plait 的适用性、更好的服务开源社区,我们将 Plait 逐步改造为无框架依赖架构,Drawnix 也是在这基础上萌生的想法,Drawnix 底层依赖 Plait 的插件机制、UI 上结合 React 及其生态,代表着除了我司主线知识库产品的另外一个重要的应用场景。
+https://drawnix.com,是 *drawnix* 的最小化应用。
-因为 Plait & Drawnix 是插件架构,与当前开源领域其它比较流行的工具 Excalidraw、TLDraw 等比技术架构更复杂一些,但是插件架构也有优势,比如能够支持多种 UI 框架(Angular、React),能够集成不同富文本框架(当前仅支持 Slate 框架),在开发上可以很好的实现业务的分层,开发各种细粒度的可复用插件,可以扩展更多的画板的应用场景。
+近期我会高频迭代 [drawnix.com](https://drawnix.com),直到发布 *Dawn* 版本。
-如果你了解富文本编辑器框架 Slate 的设计思路,那么你应该对 Drawnix 和 Plait 的架构模式很熟悉,未来我们还会探索更多有意思的应用场景。
+*欢迎大家 star ⭐️⭐️⭐️ 支持。*
# 开发
diff --git a/README_en.md b/README_en.md
new file mode 100644
index 0000000..a838b0a
--- /dev/null
+++ b/README_en.md
@@ -0,0 +1,89 @@
+<div align="center">
+ <h2>
+ Open-source whiteboard tool (SaaS), an all-in-one collaborative canvas that includes mind mapping, flowcharts and more.
+ <br />
+ </h2>
+</div>
+
+<div align="center">
+ <figure>
+ <a target="_blank" rel="noopener">
+ <img src="https://github.com/plait-board/drawnix/blob/develop/apps/web/public/product_showcase/case-2.png" alt="Product showcase" width="80%" />
+ </a>
+ <figcaption>
+ <p align="center">
+ Whiteboard with mind mapping, flowcharts, freehand drawing and more
+ </p>
+ </figcaption>
+ </figure>
+</div>
+
+[*中文文档*](https://github.com/plait-board/drawnix/blob/develop/README.md)
+
+# Features
+
+- 💯 Free and Open Source
+- ⚒️ Mind Maps and Flowcharts
+- 😀 Iconfont Emoji Support (🚧 In Progress...)
+- 🚀 Plugin-based Architecture - Extensible
+- 🖼️ 📃 Export to PNG, JPG, JSON(.drawnix)
+- 💾 Auto-save (Browser Storage)
+- ⚡ Edit Features: Undo, Redo, Copy, Paste, etc.
+- 🌌 Infinite Canvas: Zoom, Pan
+- 🎨 Theme Support (🚧 In Progress...)
+- 📱 Mobile-friendly
+
+
+# About the Name
+
+***Drawnix*** is born from the interweaving of ***Draw*** and ***Phoenix***, a fusion of artistic inspiration.
+
+The *Phoenix* symbolizes endless creativity, while *Draw* represents humanity's most fundamental form of expression. Here, each creation is an artistic rebirth, every stroke a renaissance of inspiration.
+
+Like a Phoenix, creativity must rise from the flames to be reborn, and ***Drawnix*** stands as the guardian of both technical and creative fire.
+
+*Draw Beyond, Rise Above.*
+
+# 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
+
+*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
+
+```
+npm install
+
+npm run start
+```
+
+# 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
+
+Any form of contribution is welcome:
+
+- Report bugs
+
+- Contribute code
+
+
+# License
+
+[MIT License](https://github.com/plait-board/drawnix/blob/master/LICENSE)
\ No newline at end of file