chore(.github): update update_contributors.yml and test

.github/workflows/update_contributors.yml

@@ -1,4 +1,4 @@
-name: 🤝 Update Contributeors
+name: 🤝 Update Contributors
 on:
   schedule:
     - cron: '0 1 * * *'
@@ -10,15 +10,14 @@ on:
       - alpha
       - beta
 jobs:
-  contributors:
+  contrib-readme-job:
     runs-on: ubuntu-latest
+    name: A job to automate contributors in readme
+    permissions:
+      contents: write
+      pull-requests: write
     steps:
-      - uses: wow-actions/use-app-token@v2
-        with:
-          app_id: ${{ secrets.APP_ID }}
-          private_key: ${{ secrets.PRIVATE_KEY }}
-
-      - uses: wow-actions/contributors-list@v1
-        with:
-          GITHUB_TOKEN: ${{ env.BOT_TOKEN }}
-          excludeUsers: semantic-release-bot ImgBotApp
+      - name: Generate Contributors List
+        uses: akhilmhdh/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.CONTRIBUTORS_TOKEN }}

README.en-US.md

@@ -24,3 +24,108 @@
 [简体中文](/README.md) | English
 
 LogicFlow is a flowchart editing framework , providing a series of functions necessary for flowchart interaction and editing, as well as simple and flexible node customization, plug-in and other expansion mechanisms, so that we can quickly meet the needs of class flowcharts in business systems.
+
+## Features
+
+---
+- 高可定制性：自定义能力，支持 SVG、HTML、React、Vue 等自定义节点；边的富文本编辑
+- 丰富的插件
+- 可视化模型：MVVM
+- 自执行引擎
+- 数据可转换：BPMN、...
+
+## Installation
+
+---
+```shell
+# npm
+$ npm install @logicflow/core @logicflow/extension --save
+
+# yarn
+$ yarn add @logicflow/core @logicflow/extension
+
+# pnpm
+$ pnpm add @logicflow/core @logicflow/extension
+```
+
+## Usage
+
+---
+```html
+<!-- LogicFlow 容器 DOM-->
+<div id="container"></div>;
+```
+```typescript
+// 准备数据
+const data = {
+  // 节点
+  nodes: [
+    {
+      id: '21',
+      type: 'rect',
+      x: 100,
+      y: 200,
+      text: '矩形节点',
+    },
+    {
+      id: '50',
+      type: 'circle',
+      x: 300,
+      y: 400,
+      text: '圆形节点',
+    },
+  ],
+  // 边
+  edges: [
+    {
+      type: 'polyline',
+      sourceNodeId: '50',
+      targetNodeId: '21',
+    },
+  ],
+};
+// 渲染画布
+const lf = new LogicFlow({
+  container: document.querySelector('#container'),
+  width: 700,
+  height: 600,
+});
+
+lf.render(data);
+```
+
+## Links
+
+---
+[Official Website](https://site.logic-flow.cn/)
+
+- [Getting Started](https://site.logic-flow.cn/tutorial/getting-started)
+- [Examples](https://site.logic-flow.cn/examples)
+- [Articles](https://site.logic-flow.cn/article/article01)
+
+[CHANGELOG]()
+[FAQs]()
+[Issue Template]()
+
+## Development
+
+---
+```shell
+# install deps and build
+$ pnpm install
+
+# enter the specified project for development and debugging
+cd packages/core
+pnpm run build:watch
+
+# start example to develop
+cd examples/feature-examples
+pnpm run start
+```
+
+## Contributing
+To become a contributor, please follow our [contributing guide](/CONTRUBUTING.en-US.md). If you are an active contributor, you can apply to be a outside collaborator.
+
+## License
+The scripts and documentation in this project are released under the [Apache-2.0 License](/LICENSE).
+

README.md

@@ -23,3 +23,110 @@
 简体中文 | [English](/README.en-US.md)
 
 LogicFlow 是一款流程图编辑框架，提供了一系列流程图交互、编辑所必需的功能和简单灵活的节点自定义、插件等拓展机制，方便我们快速在业务系统内满足类流程图的需求。
+
+## 核心能力
+
+---
+- 高可定制性：自定义能力，支持 SVG、HTML、React、Vue 等自定义节点；边的富文本编辑
+- 丰富的插件
+- 可视化模型：MVVM
+- 自执行引擎
+- 数据可转换：BPMN、...
+
+## 安装
+
+---
+```shell
+# npm
+$ npm install @logicflow/core @logicflow/extension --save
+
+# yarn
+$ yarn add @logicflow/core @logicflow/extension
+
+# pnpm
+$ pnpm add @logicflow/core @logicflow/extension
+```
+
+## 快速上手
+
+---
+```html
+<!-- LogicFlow 容器 DOM-->
+<div id="container"></div>;
+```
+```typescript
+// 准备数据
+const data = {
+  // 节点
+  nodes: [
+    {
+      id: '21',
+      type: 'rect',
+      x: 100,
+      y: 200,
+      text: '矩形节点',
+    },
+    {
+      id: '50',
+      type: 'circle',
+      x: 300,
+      y: 400,
+      text: '圆形节点',
+    },
+  ],
+  // 边
+  edges: [
+    {
+      type: 'polyline',
+      sourceNodeId: '50',
+      targetNodeId: '21',
+    },
+  ],
+};
+// 渲染画布
+const lf = new LogicFlow({
+  container: document.querySelector('#container'),
+  width: 700,
+  height: 600,
+});
+
+lf.render(data);
+```
+
+## 相关文档
+
+---
+[官方文档](https://site.logic-flow.cn/)
+
+- [快速上手](https://site.logic-flow.cn/tutorial/getting-started)
+- [示例](https://site.logic-flow.cn/examples)
+- [文章](https://site.logic-flow.cn/article/article01)
+
+[更新日志]()
+[常见问题]()
+[issue模板]()
+
+## 本地开发
+
+---
+```shell
+# 安装项目依赖和初始化构建
+$ pnpm install
+
+# 进入到指定项目开发和调试
+cd packages/core
+pnpm run build:watch
+
+# 启动 example 查看效果
+cd examples/feature-examples
+pnpm run start
+```
+
+## 参与共建
+如果希望参与到 LogicFlow 的开发中，请遵从我们的[贡献指南](/CONTRIBUTING.md)。如果你贡献度足够活跃，你可以申请成为社区协作者。
+
+<!-- readme: contributors -start -->
+<!-- readme: contributors -end -->
+
+## 开源协议
+该项目的代码和文档基于 [Apache-2.0 License](/LICENSE) 开源协议。

sites/docs/.dumi/theme/plugin.ts

@@ -11,11 +11,13 @@ export default (api: IApi) => {
       const language = en ? "en" : "zh";
       const userAgent = window.navigator.userAgent;
       const platform = window.navigator.platform;
-      Omega.trackEvent('tech_user_info', 'tech_urser_info', {
+      console.log('window.navigator', window.navigator);
+      Omega.trackEvent('tech_user_info', 'tech_user_info', {
         language,
         userAgent,
         platform,
         loadingTime,
+        referrer: document.referrer,
       })
       console.warn('I', language, userAgent, platform, loadingTime)
     }