diff options
Diffstat (limited to 'resources/app/node_modules/electron-squirrel-startup/README.md')
-rw-r--r-- | resources/app/node_modules/electron-squirrel-startup/README.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/resources/app/node_modules/electron-squirrel-startup/README.md b/resources/app/node_modules/electron-squirrel-startup/README.md new file mode 100644 index 0000000..54dcfc5 --- /dev/null +++ b/resources/app/node_modules/electron-squirrel-startup/README.md @@ -0,0 +1,32 @@ +# electron-squirrel-startup + +> Default [Squirrel.Windows][squirrel] event handler for your [Electron][electron] apps. + +## Installation + +``` +npm i electron-squirrel-startup +``` + +## Usage + +To handle the most common commands, 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; +``` + +## Read More + +### [Handling Squirrel Events][squirrel-events] +### [Squirrel.Windows Commands][squirrel-commands] + +## License + +Apache 2.0 + +[squirrel]: https://github.com/Squirrel/Squirrel.Windows +[electron]: https://github.com/atom/electron +[squirrel-commands]: https://github.com/Squirrel/Squirrel.Windows/blob/master/src/Update/Program.cs#L98 +[squirrel-events]: https://github.com/atom/grunt-electron-installer#handling-squirrel-events |