From fa7917fa99807bfc60155fa8c4f5624e996b7af7 Mon Sep 17 00:00:00 2001
From: yqhan <hanyuqing2@huawei.com>
Date: Thu, 11 Aug 2022 14:04:48 +0800
Subject: [PATCH] Modify the README file

issue: https://gitee.com/openharmony/js_worker_module/issues/I5LSMM

Describe: The content of the Worker module in README file needs to be
updated.

Signed-off-by: yqhan <hanyuqing2@huawei.com>
---
 README.zh.md | 72 ++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 70 insertions(+), 2 deletions(-)

diff --git a/README.zh.md b/README.zh.md
index c51d497..81ba580 100644
--- a/README.zh.md
+++ b/README.zh.md
@@ -24,7 +24,75 @@ worker能够让js拥有多线程的能力，通过postMessage完成worker线程
 
 ```
 import worker from "@ohos.worker"
-const worker = new worker.Worker("workers/worker.js");
+```
+通过判断是否与pages目录同级和创建项目的模型类别，共有以下四种新建Worker的方式：
+
+(1) FA模型: 目录同级
+```
+const workerInstance = new worker.Worker("workers/worker.js", {name:"first worker"});
+```
+(2) FA模型: 目录不同级（以workers目录放置pages目录前一级为例）
+```
+const workerInstance = new worker.Worker("../workers/worker.js", {name:"first worker"});
+```
+(3)  Stage模型: 目录同级
+```
+const workerInstance = new worker.Worker('entry/ets/workers/worker.ts');
+```
+(4) Stage模型: 目录不同级（以workers目录放置pages目录后一级为例）
+```
+const workerInstance = new worker.Worker('entry/ets/pages/workers/worker.ts');
+```
+对于Stage模型中scriptURL——"entry/ets/workers/worker.ts"的解释：
+- entry: 为module.json5中module中name属性的值；
+- ets: 表明当前工程使用的语言；
+- worker.ts: 创建worker.ts文件或者worker.js文件都可以。
+
+另外，需在工程目录下build-profile.json5文件的buildOption属性中添加配置信息，主要分为下面两种情况：
+
+(1) 目录同级(**不添加也可以**)
+
+FA模型:
+```
+  "buildOption": {
+    "sourceOption": {
+      "workers": [
+        "./src/main/ets/MainAbility/workers/worker.js"
+      ]
+    }
+  }
+```
+Stage模型:
+```
+  "buildOption": {
+    "sourceOption": {
+      "workers": [
+        "./src/main/ets/workers/worker.ts"
+      ]
+    }
+  }
+```
+(2) 目录不同级(**必须添加**)
+
+FA模型:
+```
+  "buildOption": {
+    "sourceOption": {
+      "workers": [
+        "./src/main/ets/workers/worker.js"
+      ]
+    }
+  }
+```
+Stage模型:
+```
+  "buildOption": {
+    "sourceOption": {
+      "workers": [
+        "./src/main/ets/pages/workers/worker.ts"
+      ]
+    }
+  }
 ```
 
 2. 
@@ -365,4 +433,4 @@ parentPort.onmessageerror = function(e) {
 
 ### 许可证
 
-Worker在[Mozilla许可证](https://www.mozilla.org/en-US/MPL/)下可用，说明文档详见[说明文档](https://gitee.com/openharmony/js_worker_module/blob/master/mozilla_docs.txt)。有关完整的许可证文本，有关完整的许可证文本，请参见[许可证](https://gitee.com/openharmony/js_worker_module/blob/master/LICENSE)
\ No newline at end of file
+Worker在[Apache许可证](https://gitee.com/openharmony/js_worker_module/blob/master/LICENSE)下可用，有关完整的许可证文本，请参见[许可证](https://gitee.com/openharmony/js_worker_module/blob/master/LICENSE)。
\ No newline at end of file
-- 
Gitee