Skip to content

Commit 14af54a

Browse files
committed
docs: Update README
1 parent cafde80 commit 14af54a

File tree

4 files changed

+14
-10
lines changed

4 files changed

+14
-10
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@ npm install unity-webgl
4343
- [Live Demo](https://stackblitz.com/edit/unity-webgl-v4-demo)
4444
- [vue3 Demo](https://stackblitz.com/edit/unity-webgl-v4-vue3-demo)
4545

46-
> 🚨 **Important:**
46+
> [!IMPORTANT]
47+
>
4748
> Communication and interaction with the web application are only possible after the Unity instance is successfully rendered (when the `mounted` event is triggered).
4849
> Recommended to include a loading progress bar when opening the page.
4950
@@ -134,9 +135,9 @@ Initializes the Unity application's configuration items.
134135
| `webglContextAttributes` | object | WebGL rendering context options. @see[WebGLRenderingContext][webglContextAttributes-url] | Optional |
135136
| `devicePixelRatio` | number | Canvas device pixel ratio. @see[devicePixelRatio][devicePixelRatio-url] | Optional |
136137
| `matchWebGLToCanvasSize` | boolean | Disable automatic WebGL canvas size sync. @see[matchWebGLToCanvasSize][matchWebGLToCanvasSize-url] | Optional |
137-
| `autoSyncPersistentDataPath` | boolean | Enables or disables auto synchronization of the persistent data path. | 可选 |
138-
| `disabledCanvasEvents` | string[] | Overwrites the default disabled canvas events. | 可选 |
139-
| `cacheControl` | `(url) => string` | The Cache Control API | 可选 |
138+
| `autoSyncPersistentDataPath` | boolean | Enables or disables auto synchronization of the persistent data path. | Optional |
139+
| `disabledCanvasEvents` | string[] | Overwrites the default disabled canvas events. | Optional |
140+
| `cacheControl` | `(url) => string` | The Cache Control API | Optional |
140141

141142
[devicePixelRatio-url]: https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
142143
[matchWebGLToCanvasSize-url]: https://issuetracker.unity3d.com/issues/webgl-builds-dont-allow-separate-control-on-canvas-render-buffer-size

README.zh_CN.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@ https://cdn.jsdelivr.net/npm/unity-webgl/dist/index.min.js
4343
- [Live Demo](https://stackblitz.com/edit/unity-webgl-v4-demo)
4444
- [vue3 Demo](https://stackblitz.com/edit/unity-webgl-v4-vue3-demo)
4545

46-
> 🚨 提醒:
46+
> [!IMPORTANT]
47+
>
4748
> 仅在 `UnityInstance` 渲染完成后(触发 `mounted` 事件时)才能进行 Web 应用程序的通信和交互。
4849
> 建议在页面打开时添加加载进度条。
4950

lib/core/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@ npm install unity-webgl
4343
- [Live Demo](https://stackblitz.com/edit/unity-webgl-v4-demo)
4444
- [vue3 Demo](https://stackblitz.com/edit/unity-webgl-v4-vue3-demo)
4545

46-
> 🚨 **Important:**
46+
> [!IMPORTANT]
47+
>
4748
> Communication and interaction with the web application are only possible after the Unity instance is successfully rendered (when the `mounted` event is triggered).
4849
> Recommended to include a loading progress bar when opening the page.
4950
@@ -134,9 +135,9 @@ Initializes the Unity application's configuration items.
134135
| `webglContextAttributes` | object | WebGL rendering context options. @see[WebGLRenderingContext][webglContextAttributes-url] | Optional |
135136
| `devicePixelRatio` | number | Canvas device pixel ratio. @see[devicePixelRatio][devicePixelRatio-url] | Optional |
136137
| `matchWebGLToCanvasSize` | boolean | Disable automatic WebGL canvas size sync. @see[matchWebGLToCanvasSize][matchWebGLToCanvasSize-url] | Optional |
137-
| `autoSyncPersistentDataPath` | boolean | Enables or disables auto synchronization of the persistent data path. | 可选 |
138-
| `disabledCanvasEvents` | string[] | Overwrites the default disabled canvas events. | 可选 |
139-
| `cacheControl` | `(url) => string` | The Cache Control API | 可选 |
138+
| `autoSyncPersistentDataPath` | boolean | Enables or disables auto synchronization of the persistent data path. | Optional |
139+
| `disabledCanvasEvents` | string[] | Overwrites the default disabled canvas events. | Optional |
140+
| `cacheControl` | `(url) => string` | The Cache Control API | Optional |
140141

141142
[devicePixelRatio-url]: https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
142143
[matchWebGLToCanvasSize-url]: https://issuetracker.unity3d.com/issues/webgl-builds-dont-allow-separate-control-on-canvas-render-buffer-size

lib/core/README.zh_CN.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@ https://cdn.jsdelivr.net/npm/unity-webgl/dist/index.min.js
4343
- [Live Demo](https://stackblitz.com/edit/unity-webgl-v4-demo)
4444
- [vue3 Demo](https://stackblitz.com/edit/unity-webgl-v4-vue3-demo)
4545

46-
> 🚨 提醒:
46+
> [!IMPORTANT]
47+
>
4748
> 仅在 `UnityInstance` 渲染完成后(触发 `mounted` 事件时)才能进行 Web 应用程序的通信和交互。
4849
> 建议在页面打开时添加加载进度条。
4950

0 commit comments

Comments
 (0)