Skip to content

Commit 2be625c

Browse files
authored
docs: add faq (#23)
1 parent 0dac081 commit 2be625c

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

readme.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Before using this module, make sure your Electron app meets these criteria:
1313
- Your app runs on macOS or Windows
1414
- Your app has a public GitHub repository
1515
- Your builds are published to GitHub Releases
16-
- Your builds are code-signed
16+
- Your builds are [code signed]
1717

1818
## Installation
1919

@@ -58,6 +58,25 @@ Options:
5858
- `updateInterval` String (optional) - How frequently to check for updates. Defaults to `10 minutes`. Minimum allowed interval is `5 minutes`.
5959
- `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.
6060

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+
6180
## License
6281

6382
MIT
@@ -66,4 +85,8 @@ MIT
6685

6786
If your app is packaged with `electron-builder`, you may not need this module.
6887
Builder has its own built-in mechanism for updating apps. Find out more at
69-
[electron.build/auto-update](https://www.electron.build/auto-update).
88+
[electron.build/auto-update](https://www.electron.build/auto-update).
89+
90+
[electron-forge]: https://github.com/electron-userland/electron-forge
91+
[electron-installer-zip]: https://github.com/mongodb-js/electron-installer-zip
92+
[code signed]: https://github.com/electron/electron/blob/master/docs/tutorial/code-signing.md

0 commit comments

Comments
 (0)