update - 完善工程描述

README.md

@@ -7,6 +7,7 @@
 
 > Flowable的数据库名称以ACT_开头。第二部分是表用例的两个字符的标识。
 
+**Activiti 标准延续:**
 ```text
 - ACT_FO_*：“FO“代表表单引擎相关库。包含表单定义，部署，实例等。
 - ACT_RE_*：“RE”代表存储库。具有此前缀的表包含“静态”信息，例如流程定义和流程资源。
@@ -15,6 +16,7 @@
 - ACT_GE_*：“GE“代表自动生成的数据，包括bpmn.xml、flowable自带流程图等文件，用于各种用例。
 ```
 
+**Flowable 的扩展:**
 ```text
 - flw_*：Flowable 新版本扩展功能相关的表，流程迁移的表。
 ```

workflow-engine-core/src/main/java/cn/axzo/workflow/core/conf/FlowableConfiguration.java

@@ -13,7 +13,7 @@ import org.springframework.context.annotation.Configuration;
 import static org.flowable.common.engine.impl.AbstractEngineConfiguration.DB_SCHEMA_UPDATE_FALSE;
 
 /**
- * TODO
+ * Flowable 引擎相关全局配置
  *
  * @author wangli
  * @since 2023/7/13 11:18

workflow-engine-core/src/main/resources/readme.md

@@ -1,9 +1,38 @@
-## RocketMQ 使用说明
+## 一、Core 包说明
+
+### 概要信息
+
+> 1. 该包可以独立的被二方/三方以 jar 包的形式引入工程, 即可使用 Flowable 引擎,例如枢智业务便是以此方式进行实践.
+> 2. 该包中 `src/main/resources/sql` 是 Flowable 引擎会使用的库表结构, 使用前需要执行创建.
+> 3. 该包中 `cn/axzo/workflow/core/service` 下的 Service 接口是主要是抽象集成的 API, 业务主要也是使用这些 API.
+
+### 接口描述
+
+```properties
+BpmnProcessModelService:流程模型管理
+BpmnProcessDefinitionService:流程定义管理
+BpmnProcessInstanceService:流程实例管理
+BpmnProcessTaskService:流程实例下任务管理
+FormModelService:表单模型管理
+FormDefinitionService:表单定义管理
+FormInstanceService:表单实例管理
+```
+
+### 库表描述
+
+> - ACT_RE ：'RE' 表示 repository。这个前缀的表包含了流程定义和流程静态资源（图片，规则，等等）。
+> - ACT_RU：'RU' 表示
+    runtime。这些运行时的表，包含流程实例，任务，变量，异步任务，等运行中的数据。Flowable只在流程实例执行过程中保存这些数据，在流程结束时就会删除这些记录。这样运行时表可以一直很小速度很快。
+> - ACT_HI：'HI' 表示 history。这些表包含历史数据，比如历史流程实例，变量，任务等等。
+> - ACT_GE：'GE' 表示 general。通用数据，用于不同场景下。
+> - ACT_ID: 'ID' 表示 identity (组织机构)。这些表包含标识的信息，如用户，用户组，等等。
+
+## 二、RocketMQ 使用说明
 
 1. 服务方需要主动引入二方包
 
 > ```xml
->    <dependency>
+>        <dependency>
 >            <groupId>cn.axzo.workflow</groupId>
 >            <artifactId>workflow-engine-core</artifactId>
 >            <version>1.0.1-SNAPSHOT</version>