diff --git a/README.md b/README.md index 7f4e2cf..0ccecac 100644 --- a/README.md +++ b/README.md @@ -70,10 +70,10 @@ export default { } ``` -## 🔧Additional features +## 🔧 Additional features -1. electron-auto-update([read it docs](src/components/update/README.md)); -1. playwright; +1. electron-updater 👉 [see docs](src/components/update/README.md) +1. playwright ## ❔ FAQ diff --git a/README.zh-CN.md b/README.zh-CN.md index 917122c..2cdd50f 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -67,10 +67,10 @@ export default { } ``` -## 🔧额外的功能 +## 🔧 额外的功能 -1. Electron自动更新([阅读文档](src/components/update/README.zh-CN.md)); -2. Playwright测试; +1. Electron 自动更新 👉 [阅读文档](src/components/update/README.zh-CN.md) +2. Playwright 测试 ## ❔ FAQ diff --git a/electron-builder.json5 b/electron-builder.json5 index e568aa9..6c82482 100644 --- a/electron-builder.json5 +++ b/electron-builder.json5 @@ -35,9 +35,9 @@ "allowToChangeInstallationDirectory": true, "deleteAppDataOnUninstall": false }, - publish:{ - provider: 'generic', - channel: 'latest', - url: 'https://github.com/electron-vite/electron-vite-react/releases/download/v0.9.9/', + "publish": { + "provider": "generic", + "channel": "latest", + "url": "https://github.com/electron-vite/electron-vite-react/releases/download/v0.9.9/" } -} \ No newline at end of file +} diff --git a/src/components/update/README.md b/src/components/update/README.md index 75c264f..d119a11 100644 --- a/src/components/update/README.md +++ b/src/components/update/README.md @@ -1,8 +1,8 @@ -# electron-auto-update +# electron-updater English | [简体中文](README.zh-CN.md) -Use `electron-updater` to realize the update detection, download and installation of the electric program. +> Use `electron-updater` to realize the update detection, download and installation of the electric program. ```sh npm i electron-updater @@ -14,12 +14,14 @@ npm i electron-updater Add a `publish` field to `electron-builder.json5` for configuring the update address and which strategy to use as the update service. - ```json - publish:{ - provider: 'generic', - channel: 'latest', - url: 'https://github.com/xxxx/', - } + ``` json5 + { + "publish": { + "provider": "generic", + "channel": "latest", + "url": "https://foo.com/" + } + } ``` For more information, please refer to : [electron-builder.json5...](https://github.com/electron-vite/electron-vite-react/blob/2f2880a9f19de50ff14a0785b32a4d5427477e55/electron-builder.json5#L38) diff --git a/src/components/update/README.zh-CN.md b/src/components/update/README.zh-CN.md index 2d1ce04..f2c65fc 100644 --- a/src/components/update/README.zh-CN.md +++ b/src/components/update/README.zh-CN.md @@ -14,13 +14,15 @@ npm i electron-updater 在`electron-builder.json5`添加`publish`字段,用来配置更新地址和使用哪种策略作为更新服务 -``` json - publish:{ - provider: 'generic', //提供者、提供商 - channel: 'latest',//生成yml文件的名称 - url: 'https://github.com/xxxx/',//更新地址 - } -``` + ``` json5 + { + "publish": { + "provider": "generic", // 提供者、提供商 + "channel": "latest", // 生成yml文件的名称 + "url": "https://foo.com/" //更新地址 + } + } + ``` 更多见 : [electron-builder.json5...](xxx)