docs: update

README.md

@@ -1,3 +1 @@
-# tango
-
-一个基于源码的低代码引擎
+packages/designer/README.md

packages/designer/README.md

@@ -1,5 +1,94 @@
-# Tango 低代码设计器
+<h1 align="center">Tango LowCode Designer</h1>
+<div align="center">
 
-## 使用文档
+A source code based low-code designer from the NetEase Cloud Music Develop Team.
 
-https://tango-docs.st.netease.com/
+</div>
+
+English | [简体中文](./README.zh-CN.md)
+
+## ✨ Features
+
+- Tested in the production environment of NetEase Cloud Music, can be flexibly integrated into low-code platforms, local development tools, etc.
+- Based on source code AST, with no private DSL and protocol
+  Real-time code generation capability, supporting source code in and source code out
+- Out-of-the-box front-end low-code designer, providing flexible and easy-to-use designer React components
+- Developed using TypeScript, providing complete type definition files
+
+## 🎯 Compatibility
+
+- Modern browsers（Chrome >= 80, Edge >= 80, last 2 safari versions, last 2 firefox versions）
+
+## 📄 Usage
+
+Install the low-code designer
+
+```bash
+npm install @music163/tango-designer
+```
+
+Initialize the low-code designer engine
+
+```js
+import { createEngine } form '@music163/tango-designer';
+
+// init designer engine
+const engine = createEngine({
+  entry: '/src/index.js',
+  files: sampleFiles,
+  componentPrototypes: prototypes as any,
+});
+```
+
+Initialize the drag-and-drop engine
+
+```js
+import { DndQuery } form '@music163/tango-designer';
+
+const sandboxQuery = new DndQuery({
+  context: 'iframe',
+});
+```
+
+Initialize the designer layout (WIP)
+
+Find details from [Documentation Site](./#)。
+
+## 💻 Development
+
+### Recommended Development Environment
+
+- Node.js >= 16.0.0
+- Yarn >= 1.22.0
+
+### Development Quick Start
+
+
+```bash
+# clone the repo
+git clone https://github.com/NetEase/tango.git
+
+# enter the project root
+cd tango
+
+# install dependencies
+yarn
+
+# start the designer playground app
+yarn start
+```
+
+## 🤝 Contributing
+
+Please read the [github contribution guide](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) first。
+
+- Clone the repository
+- Create a branch
+- Commit and push your code
+- Open a Pull Request
+
+## 💗 Acknowledgments
+
+Thanks to the NetEase Cloud Music Front-end team, Public Technology team, Live Broadcasting Technology team, and all the colleagues who participated in the Tango project.
+
+Thank you to CodeSandbox for providing the [Sandpack](https://sandpack.codesandbox.io/) project, which provides powerful online code execution capabilities for Tango.

packages/designer/README.zh-CN.md

@@ -0,0 +1,94 @@
+<h1 align="center">Tango 低代码设计器</h1>
+<div align="center">
+
+一个源码驱动的低代码设计器，来自网易云音乐技术团队
+
+</div>
+
+简体中文 | [English](./README.md)
+
+## ✨ 特性
+
+- 经历网易云音乐内网生产环境的实际检验，可灵活集成应用于低代码平台，本地开发工具等
+- 基于源码 AST 驱动，无私有 DSL 和协议
+- 提供实时出码能力，支持源码进，源码出
+- 开箱即用的前端低代码设计器，提供灵活易用的设计器 React 组件
+- 使用 TypeScript 开发，提供完整的类型定义文件
+
+## 🎯 兼容环境
+
+- 现代浏览器（Chrome >= 80, Edge >= 80, last 2 safari versions, last 2 firefox versions）
+
+## 📄 如何使用
+
+安装设计器
+
+```bash
+npm install @music163/tango-designer
+```
+
+初始化设计器内核
+
+```js
+import { createEngine } form '@music163/tango-designer';
+
+// 引擎初始化
+const engine = createEngine({
+  entry: '/src/index.js',
+  files: sampleFiles,
+  componentPrototypes: prototypes as any,
+});
+```
+
+初始化拖拽引擎
+
+```js
+import { DndQuery } form '@music163/tango-designer';
+
+const sandboxQuery = new DndQuery({
+  context: 'iframe',
+});
+```
+
+设计器框架初始化(WIP)
+
+详细使用方法请参考 [使用文档](./#)。
+
+## 💻 开发
+
+### 推荐开发环境
+
+- Node.js >= 16.0.0
+- Yarn >= 1.22.0
+
+### 本地开发调试方法
+
+```bash
+# 下载仓库
+git clone https://github.com/NetEase/tango.git
+
+# 进入项目根目录
+cd tango
+
+# 安装依赖
+yarn
+
+# 启动设计器示例
+yarn start
+```
+
+## 🤝 参与共建
+
+请先阅读 [贡献指南](https://docs.github.com/en/get-started/quickstart/contributing-to-projects)。
+
+- 克隆仓库
+- 创建分支
+- 提交代码
+- 合并修改 git rebase master
+- 发起 Pull Request
+
+## 💗 致谢
+
+感谢网易云音乐大前端团队，公共技术团队，直播技术团队，以及所有参与过 Tango 项目的同学们。
+
+感谢 CodeSandbox 提供的 [Sandpack](https://sandpack.codesandbox.io/) 项目，为 Tango 提供了强大的在线代码执行能力。