From 021274c83dd8e1dea83e63e7476e8f57ec674149 Mon Sep 17 00:00:00 2001 From: eric2788 Date: Sat, 13 Apr 2024 19:32:22 +0800 Subject: [PATCH] updated docs and fixed typo --- README.md | 6 ++++-- docs/background.md | 1 + docs/settings.md | 2 +- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0e6a2ed9..8cf77590 100644 --- a/README.md +++ b/README.md @@ -48,10 +48,12 @@ ## ➵ 使用方式 1. [下载](#-下载)本扩展。 -2. 点击扩展图标进入设定页面，并根据你的偏好进入设定。完成后，然后按下保存设定。 +2. 点击扩展图标进入设定页面，并根据你的偏好进行设定。完成后，按下保存设定。 3. 进入B站任一直播间即可开始使用。 -详情可参阅 [使用指南](https://eric2788.github.io/bilibili-vup-stream-enhancer/tutorials) +> 本扩展的所有功能基本上可以到设定页面自行探索和试用，便不再加篇章一一赘述。 +> +> 不过考虑到有些功能可能比较难以察觉，故写了篇 [使用指南](https://eric2788.github.io/bilibili-vup-stream-enhancer/tutorials) (仅限难以察觉的功能)。 ## ➵ 贡献 diff --git a/docs/background.md b/docs/background.md index 7a7e3672..6cd97498 100644 --- a/docs/background.md +++ b/docs/background.md @@ -126,6 +126,7 @@ const menus = [ - 把内容脚本的弹幕数据发送到扩展页面 - 把内容脚本的同传字幕发送到扩展页面 - 扩展页面的重启指令发送到内容脚本 +- 发送预编译的视频数据到扩展页面 例子如下: ```ts diff --git a/docs/settings.md b/docs/settings.md index 5c2f5892..244fce11 100644 --- a/docs/settings.md +++ b/docs/settings.md @@ -156,7 +156,7 @@ function App(): JSX.Element { - 使用 [`getSettingStorage`](/src/utils/storage.ts) 函数: ```ts -const helloWorldSettings = getSettingStorage('settings.helloWorld') +const helloWorldSettings = await getSettingStorage('settings.helloWorld') ``` > 此方式返回的数据本身包含设定结构，因此无需手动标注类型。