diff --git a/README.md b/README.md index c4ab0fd..d1f287d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # electron-node-red -This is an Electron template to embed Node-RED with a UI generated by node-red-contrib-ui +This is an Electron template to embed Node-RED with a UI generated by node-red-contrib-ui. + +You can base off this model and update the package.json file to include your own required dependencies. ## To Use @@ -15,6 +17,23 @@ cd electron-node-red npm install && npm start ``` +## Packaging your application + +If you want to distribute executables of this project, the easiest way is to use electron-packager: + +``` +sudo npm install -g electron-packager + +# build fox OS X 64 bits +electron-packager electron-node-red MyAppName --platform=darwin --arch=x64 + +# build fox Windows 64 bits +electron-packager electron-node-red MyAppName --platform=win32 --arch=x64 + +# build fox OS X 64 bits +electron-packager electron-node-red MyAppName --platform=linux --arch=x64 +``` + Learn more about Electron and its API in the [documentation](http://electron.atom.io/docs/latest). #### License [CC0 (Public Domain)](LICENSE.md)