docs: Update READMEs for v4.x changes

Marinerer · Marinerer · commit 72605947818f · 2024-12-20T21:44:27.000+08:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,7 +15,7 @@
 - Add initial package and tsconfig for components and core &nbsp;-&nbsp; by @Marinerer [<samp>(5deba)</samp>](https://github.com/Marinerer/unity-webgl/commit/5deba6b)
 - Add UnityWebglComponent for Vue integration &nbsp;-&nbsp; by @Marinerer [<samp>(68e23)</samp>](https://github.com/Marinerer/unity-webgl/commit/68e237e)
 - Add comprehensive UnityWebgl testing suite &nbsp;-&nbsp; by @Marinerer [<samp>(82330)</samp>](https://github.com/Marinerer/unity-webgl/commit/823307c)
-- 
+
 ### &nbsp;&nbsp;&nbsp;📝 Documentation
 
 - Add documentation &nbsp;-&nbsp; by @Marinerer [<samp>(f0411)</samp>](https://github.com/Marinerer/unity-webgl/commit/f041121)
diff --git a/README.md b/README.md
@@ -1,6 +1,8 @@
 # unity-webgl
 
 [![version](https://img.shields.io/npm/v/unity-webgl?style=flat-square)](https://www.npmjs.com/package/unity-webgl)
+[![codecov](https://codecov.io/gh/Marinerer/unity-webgl/graph/badge.svg?token=7J0R98DRUB)](https://codecov.io/gh/Marinerer/unity-webgl)
+[![release](https://img.shields.io/github/actions/workflow/status/Marinerer/unity-webgl/release.yml?style=flat-square)](https://github.com/Marinerer/unity-webgl/releases)
 [![downloads](https://img.shields.io/npm/dm/unity-webgl?style=flat-square)](https://www.npmjs.com/package/unity-webgl)
 [![size](https://img.shields.io/bundlephobia/minzip/unity-webgl?style=flat-square)](https://bundlephobia.com/package/unity-webgl)
 [![license](https://img.shields.io/npm/l/unity-webgl?style=flat-square)](https://github.com/Marinerer/unity-webgl)
@@ -9,8 +11,9 @@
 
 `unity-webgl` provides an easy solution for embedding `Unity WebGL` builds in your web applications, with two-way communication and interaction between your webApp and Unity application with advanced API's.
 
-> Framework agnostic, usable in any web project.
-> Currently includes Vue components, supporting both Vue 2/3.
+> 🚨 Reminder
+> 
+> `v4.x` has been updated significantly and the API is not compatible with `v3.x` and earlier versions. For upgrades, please refer to [Changelogs](https://github.com/Marinerer/unity-webgl/wiki/Major-changes-in-v4)
 
 Based on [react-unity-webgl](https://github.com/jeffreylanters/react-unity-webgl)
 
@@ -118,10 +121,10 @@ Initializes the Unity application's configuration items.
 
 | Property                 | Type    | Description                                                                                        | Required |
 | ------------------------ | ------- | -------------------------------------------------------------------------------------------------- | -------- |
-| `loaderUrl`              | string  | Unity resource loader file                                                                         | ✅       |
-| `dataUrl`                | string  | File containing resource data and scenes                                                           | ✅       |
-| `frameworkUrl`           | string  | File with runtime and plugin code                                                                  | ✅       |
-| `codeUrl`                | string  | WebAssembly binary file with native code                                                           | ✅       |
+| `loaderUrl`              | string  | Unity resource loader file                                                                         | ✅        |
+| `dataUrl`                | string  | File containing resource data and scenes                                                           | ✅        |
+| `frameworkUrl`           | string  | File with runtime and plugin code                                                                  | ✅        |
+| `codeUrl`                | string  | WebAssembly binary file with native code                                                           | ✅        |
 | `streamingAssetsUrl`     | string  | URL for streaming resources                                                                        | Optional |
 | `memoryUrl`              | string  | URL for generated framework files                                                                  | Optional |
 | `symbolsUrl`             | string  | URL for generated Unity code files                                                                 | Optional |
diff --git a/README.zh_CN.md b/README.zh_CN.md
@@ -1,6 +1,8 @@
 # unity-webgl
 
 [![version](https://img.shields.io/npm/v/unity-webgl?style=flat-square)](https://www.npmjs.com/package/unity-webgl)
+[![codecov](https://codecov.io/gh/Marinerer/unity-webgl/graph/badge.svg?token=7J0R98DRUB)](https://codecov.io/gh/Marinerer/unity-webgl)
+[![release](https://img.shields.io/github/actions/workflow/status/Marinerer/unity-webgl/release.yml?style=flat-square)](https://github.com/Marinerer/unity-webgl/releases)
 [![downloads](https://img.shields.io/npm/dm/unity-webgl?style=flat-square)](https://www.npmjs.com/package/unity-webgl)
 [![size](https://img.shields.io/bundlephobia/minzip/unity-webgl?style=flat-square)](https://bundlephobia.com/package/unity-webgl)
 [![license](https://img.shields.io/npm/l/unity-webgl?style=flat-square)](https://github.com/Marinerer/unity-webgl)
@@ -9,17 +11,19 @@
 
 `unity-webgl` 提供了一个简单的解决方案，用于将 `Unity WebGL` 构建嵌入到 Web 应用程序中，同时为 Unity 和 WebApp 应用之间的双向通信和交互提供 API。
 
-> 无框架限制，可用于任何 Web 项目。
-> 目前仅内置vue组件，支持 `vue2/3`。
+> 🚨 提醒
+> 
+> `v4.x` 版本进行了较大更新，API 不兼容 `v3.x`及之前版本。升级请参考 [变更信息](https://github.com/Marinerer/unity-webgl/wiki/Major-changes-in-v4)
+
 
 Based on [react-unity-webgl](https://github.com/jeffreylanters/react-unity-webgl)
 
 ## Features
 
-📦 集成简单，无框架限制
-📩 支持 `WebApp` 与 `Unity` 双向通信和交互
-⏰ 全面的事件处理机制
-🧲 内置 `vue` 组件 (vue2/3)
+- 📦 集成简单，无框架限制
+- 📩 支持 `WebApp` 与 `Unity` 双向通信和交互
+- ⏰ 全面的事件处理机制
+- 🧲 内置 `vue` 组件 (`vue2/3`)
 
 ## Installation
 
@@ -118,10 +122,10 @@ unityContext.create(canvas: HTMLCanvasElement | string)
 
 | Property                 | Type    | Description                                                                           | Required |
 | ------------------------ | ------- | ------------------------------------------------------------------------------------- | -------- |
-| `loaderUrl`              | string  | Unity 资源加载器文件                                                                  | ✅       |
-| `dataUrl`                | string  | 包含资源数据和场景的文件                                                              | ✅       |
-| `frameworkUrl`           | string  | 包含运行时和插件代码的文件                                                            | ✅       |
-| `codeUrl`                | string  | 包含原生代码的 WebAssembly 二进制文件                                                 | ✅       |
+| `loaderUrl`              | string  | Unity 资源加载器文件                                                                  | ✅        |
+| `dataUrl`                | string  | 包含资源数据和场景的文件                                                              | ✅        |
+| `frameworkUrl`           | string  | 包含运行时和插件代码的文件                                                            | ✅        |
+| `codeUrl`                | string  | 包含原生代码的 WebAssembly 二进制文件                                                 | ✅        |
 | `streamingAssetsUrl`     | string  | 流媒体资源的 URL                                                                      | 可选     |
 | `memoryUrl`              | string  | 生成的框架文件的 URL                                                                  | 可选     |
 | `symbolsUrl`             | string  | 生成的 Unity 代码文件的 URL                                                           | 可选     |
@@ -329,6 +333,8 @@ public class WebGLPluginJS : MonoBehaviour
 - [调试 WebGL 构建并排除故障](https://docs.unity3d.com/cn/2023.2/Manual/webgl-debugging.html)
 - [WebGL 性能考虑因素](https://docs.unity3d.com/cn/2023.2/Manual/webgl-performance.html)
 
+
+
 ## License
 
 MIT License
diff --git a/lib/core/README.md b/lib/core/README.md
@@ -1,6 +1,8 @@
 # unity-webgl
 
 [![version](https://img.shields.io/npm/v/unity-webgl?style=flat-square)](https://www.npmjs.com/package/unity-webgl)
+[![codecov](https://codecov.io/gh/Marinerer/unity-webgl/graph/badge.svg?token=7J0R98DRUB)](https://codecov.io/gh/Marinerer/unity-webgl)
+[![release](https://img.shields.io/github/actions/workflow/status/Marinerer/unity-webgl/release.yml?style=flat-square)](https://github.com/Marinerer/unity-webgl/releases)
 [![downloads](https://img.shields.io/npm/dm/unity-webgl?style=flat-square)](https://www.npmjs.com/package/unity-webgl)
 [![size](https://img.shields.io/bundlephobia/minzip/unity-webgl?style=flat-square)](https://bundlephobia.com/package/unity-webgl)
 [![license](https://img.shields.io/npm/l/unity-webgl?style=flat-square)](https://github.com/Marinerer/unity-webgl)
@@ -9,8 +11,9 @@
 
 `unity-webgl` provides an easy solution for embedding `Unity WebGL` builds in your web applications, with two-way communication and interaction between your webApp and Unity application with advanced API's.
 
-> Framework agnostic, usable in any web project.
-> Currently includes Vue components, supporting both Vue 2/3.
+> 🚨 Reminder
+> 
+> `v4.x` has been updated significantly and the API is not compatible with `v3.x` and earlier versions. For upgrades, please refer to [Changelogs](https://github.com/Marinerer/unity-webgl/wiki/Major-changes-in-v4)
 
 Based on [react-unity-webgl](https://github.com/jeffreylanters/react-unity-webgl)
 
@@ -118,10 +121,10 @@ Initializes the Unity application's configuration items.
 
 | Property                 | Type    | Description                                                                                        | Required |
 | ------------------------ | ------- | -------------------------------------------------------------------------------------------------- | -------- |
-| `loaderUrl`              | string  | Unity resource loader file                                                                         | ✅       |
-| `dataUrl`                | string  | File containing resource data and scenes                                                           | ✅       |
-| `frameworkUrl`           | string  | File with runtime and plugin code                                                                  | ✅       |
-| `codeUrl`                | string  | WebAssembly binary file with native code                                                           | ✅       |
+| `loaderUrl`              | string  | Unity resource loader file                                                                         | ✅        |
+| `dataUrl`                | string  | File containing resource data and scenes                                                           | ✅        |
+| `frameworkUrl`           | string  | File with runtime and plugin code                                                                  | ✅        |
+| `codeUrl`                | string  | WebAssembly binary file with native code                                                           | ✅        |
 | `streamingAssetsUrl`     | string  | URL for streaming resources                                                                        | Optional |
 | `memoryUrl`              | string  | URL for generated framework files                                                                  | Optional |
 | `symbolsUrl`             | string  | URL for generated Unity code files                                                                 | Optional |
diff --git a/lib/core/README.zh_CN.md b/lib/core/README.zh_CN.md
@@ -1,6 +1,8 @@
 # unity-webgl
 
 [![version](https://img.shields.io/npm/v/unity-webgl?style=flat-square)](https://www.npmjs.com/package/unity-webgl)
+[![codecov](https://codecov.io/gh/Marinerer/unity-webgl/graph/badge.svg?token=7J0R98DRUB)](https://codecov.io/gh/Marinerer/unity-webgl)
+[![release](https://img.shields.io/github/actions/workflow/status/Marinerer/unity-webgl/release.yml?style=flat-square)](https://github.com/Marinerer/unity-webgl/releases)
 [![downloads](https://img.shields.io/npm/dm/unity-webgl?style=flat-square)](https://www.npmjs.com/package/unity-webgl)
 [![size](https://img.shields.io/bundlephobia/minzip/unity-webgl?style=flat-square)](https://bundlephobia.com/package/unity-webgl)
 [![license](https://img.shields.io/npm/l/unity-webgl?style=flat-square)](https://github.com/Marinerer/unity-webgl)
@@ -9,17 +11,19 @@
 
 `unity-webgl` 提供了一个简单的解决方案，用于将 `Unity WebGL` 构建嵌入到 Web 应用程序中，同时为 Unity 和 WebApp 应用之间的双向通信和交互提供 API。
 
-> 无框架限制，可用于任何 Web 项目。
-> 目前仅内置vue组件，支持 `vue2/3`。
+> 🚨 提醒
+> 
+> `v4.x` 版本进行了较大更新，API 不兼容 `v3.x`及之前版本。升级请参考 [变更信息](https://github.com/Marinerer/unity-webgl/wiki/Major-changes-in-v4)
+
 
 Based on [react-unity-webgl](https://github.com/jeffreylanters/react-unity-webgl)
 
 ## Features
 
-📦 集成简单，无框架限制
-📩 支持 `WebApp` 与 `Unity` 双向通信和交互
-⏰ 全面的事件处理机制
-🧲 内置 `vue` 组件 (vue2/3)
+- 📦 集成简单，无框架限制
+- 📩 支持 `WebApp` 与 `Unity` 双向通信和交互
+- ⏰ 全面的事件处理机制
+- 🧲 内置 `vue` 组件 (`vue2/3`)
 
 ## Installation
 
@@ -118,10 +122,10 @@ unityContext.create(canvas: HTMLCanvasElement | string)
 
 | Property                 | Type    | Description                                                                           | Required |
 | ------------------------ | ------- | ------------------------------------------------------------------------------------- | -------- |
-| `loaderUrl`              | string  | Unity 资源加载器文件                                                                  | ✅       |
-| `dataUrl`                | string  | 包含资源数据和场景的文件                                                              | ✅       |
-| `frameworkUrl`           | string  | 包含运行时和插件代码的文件                                                            | ✅       |
-| `codeUrl`                | string  | 包含原生代码的 WebAssembly 二进制文件                                                 | ✅       |
+| `loaderUrl`              | string  | Unity 资源加载器文件                                                                  | ✅        |
+| `dataUrl`                | string  | 包含资源数据和场景的文件                                                              | ✅        |
+| `frameworkUrl`           | string  | 包含运行时和插件代码的文件                                                            | ✅        |
+| `codeUrl`                | string  | 包含原生代码的 WebAssembly 二进制文件                                                 | ✅        |
 | `streamingAssetsUrl`     | string  | 流媒体资源的 URL                                                                      | 可选     |
 | `memoryUrl`              | string  | 生成的框架文件的 URL                                                                  | 可选     |
 | `symbolsUrl`             | string  | 生成的 Unity 代码文件的 URL                                                           | 可选     |
@@ -329,6 +333,8 @@ public class WebGLPluginJS : MonoBehaviour
 - [调试 WebGL 构建并排除故障](https://docs.unity3d.com/cn/2023.2/Manual/webgl-debugging.html)
 - [WebGL 性能考虑因素](https://docs.unity3d.com/cn/2023.2/Manual/webgl-performance.html)
 
+
+
 ## License
 
 MIT License
