Skip to content

Commit f9686f8

Browse files
committed
docs: update README.md
1 parent 4d08e5d commit f9686f8

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,11 @@ Detect webpage updates and notify user to reload. support vite, umijs and webpac
3838
3. script resource loading failure detected (404 ?).
3939
4. when the tab page is refocus or revisible.
4040

41+
**How to see the update notification**
42+
43+
Install the current plugin (using the default configuration), package and deploy it -> Open a browser to visit the webpage (Tab A) -> Modify the code, repackage and redeploy -> Re-enter the previously opened Tab A. Here you can see the update notification in the lower right corner.
44+
Note that the current plugin will not take effect in development mode.
45+
4146
## Why
4247

4348
Some users do not have the habit of closing web pages. If the front-end page is updated, the user page has always been a historical version, any there may be report an error (file 404) or a white screen.

README.zh-CN.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,19 @@
3030
<img width="180" src="https://raw.githubusercontent.com/GreatAuk/plugin-web-update-notification/main/images/svelte_example.webp">
3131
<img width="180" src="https://raw.githubusercontent.com/GreatAuk/plugin-web-update-notification/main/images/react_umi_example.webp">
3232
</p>
33-
**什么时候会检测更新(fetch version.json)** ?
33+
34+
**什么时候会检测更新(fetch version.json)** ?
3435

3536
1. 首次加载页面。
3637
2. 轮询 (default: 10 * 60 * 1000 ms)。
3738
3. script 脚本资源加载失败 (404 ?)。
3839
4. 标签页 refocus or revisible。
3940

41+
**如何才能看到更新提示**
42+
43+
安装当前插件(使用默认配置),打包并部署 -> 打开浏览器访问网页(标签页A) -> 修改代码,重新打包并部署 -> 重新进入刚才打开的标签页 A。 这里你可以在右下角看到更新提示。
44+
注意,开发模式下当前插件不会生效。
45+
4046
## Why
4147

4248
部分用户(老板)没有关闭网页的习惯,在网页有新版本更新或问题修复时,用户继续使用旧的版本,影响用户体验和后端数据准确性。也有可能会出现报错(文件404)、白屏的情况。

0 commit comments

Comments
 (0)