You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: readme.md
+25-2Lines changed: 25 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ Before using this module, make sure your Electron app meets these criteria:
13
13
- Your app runs on macOS or Windows
14
14
- Your app has a public GitHub repository
15
15
- Your builds are published to GitHub Releases
16
-
- Your builds are code-signed
16
+
- Your builds are [codesigned]
17
17
18
18
## Installation
19
19
@@ -58,6 +58,25 @@ Options:
58
58
-`updateInterval` String (optional) - How frequently to check for updates. Defaults to `10 minutes`. Minimum allowed interval is `5 minutes`.
59
59
-`logger` Object (optional) - A custom logger object that defines a `log` function. Defaults to `console`. See [electron-log](https://github.com/megahertz/electron-log), a module that aggregates logs from main and renderer processes into a single file.
60
60
61
+
## FAQ
62
+
63
+
#### What kinds of assets do I need to build?
64
+
65
+
For macOS, you'll need to build a `.zip` file and include it in your GitHub Release.
66
+
Use [electron-forge] or [electron-installer-zip] to package your app as a zip.
67
+
68
+
For Windows, you'll need to build a `.exe` file and include it in your GitHub Release.
69
+
70
+
#### Why is my app launching multiple times?
71
+
72
+
Windows apps have an update process that requires multiple application restarts.
73
+
You can use the [electron-squirrel-startup](https://github.com/mongodb-js/electron-squirrel-startup) module to improve this
74
+
behavior.
75
+
76
+
#### Can I use this module by uploading my private app's builds to a public GitHub repository?
77
+
78
+
Yes :)
79
+
61
80
## License
62
81
63
82
MIT
@@ -66,4 +85,8 @@ MIT
66
85
67
86
If your app is packaged with `electron-builder`, you may not need this module.
68
87
Builder has its own built-in mechanism for updating apps. Find out more at
0 commit comments