wip

Author: mpociot

README.md

@@ -4,6 +4,24 @@ A Laravel DebugBar companion app that helps you debug your applications.
 
 ![](https://beyondco.de/github/laravel-debugbar-companion/companion.png)
 
+## Installation
+
+You can download the latest version of this application for MacOS, Windows, and Linux on the [releases page](https://github.com/beyondcode/laravel-debugbar-companion/releases).
+
+There is currently an [open PR](https://github.com/barryvdh/laravel-debugbar/pull/1141) on the Laravel DebugBar repository, that explains how to connect the Laravel DebugBar with the companion app.
+
+### Contributing
+
+To get the application running locally, first install all required dependencies using `yarn`.
+
+The application can be started in development mode using:
+
+```
+yarn electron:serve
+```
+
+This will start the application in a hot-reloading mode, so all changes will be immediately visible within the application.
+
 ### Security
 
 If you discover any security related issues, please email [email protected] instead of using the issue tracker.

package.json

@@ -13,7 +13,11 @@
     "build:osx": "yarn electron:build -p never",
     "build:win": "yarn electron:build -p never -- --win  --x64 --ia32",
     "build:linux": "yarn electron:build -p never -- --linux",
-    "build:all": "yarn run build:osx && yarn run build:win && yarn run build:linux"
+    "build:all": "yarn run build:osx && yarn run build:win && yarn run build:linux",
+    "publish:osx": "yarn electron:build -p always",
+    "publish:win": "yarn electron:build -- --win  --x64 --ia32 -p always",
+    "publish:linux": "yarn electron:build -p always -- --linux -p always",
+    "publish:all": "yarn run publish:osx && yarn run publish:win && yarn run publish:linux"
   },
   "repository": {
     "type": "git",