Skip to content

Commit

Permalink
Add info about electron-squirrel-startup
Browse files Browse the repository at this point in the history
  • Loading branch information
develar committed Apr 5, 2016
1 parent 3d70e4c commit 71b12bf
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,14 @@ and uninstalls. it is **very** important that your app handle these events as _e
as possible, and quit **immediately** after handling them. Squirrel will give your
app a short amount of time (~15sec) to apply these operations and quit.

The [electron-squirrel-startup](https://github.com/mongodb-js/electron-squirrel-startup) module will handle
the most common events for you, such as managing desktop shortcuts. Just
add the following to the top of your `main.js` and you're good to go:

```js
if (require('electron-squirrel-startup')) return;
```

You should handle these events in your app's `main` entry point with something
such as:

Expand Down

0 comments on commit 71b12bf

Please sign in to comment.