Add automatic workflow for building binaries

Author: bryan-ente

.github/workflows/release.yml

@@ -0,0 +1,36 @@
+name: Build & Release Binary
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Install pkg
+        run: npm install -g pkg
+
+      - name: Build binaries
+        run: pkg . --out-path dist
+
+      - name: Upload to GitHub Releases
+        uses: softprops/action-gh-release@v1
+        with:
+          files: |
+            dist/protoparser-win.exe
+            dist/protoparser-linux
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -129,6 +129,12 @@ protparser [options] [filename] [format]
 protoparser -vvv -output=myfile MeetingYesterday.pml html
 ```
 
+### Local development
+
+- Clone the repository
+- Make your changes
+- Run `npm run build:exe` to build linux and windows executables or simply run `npm uninstall -g protoparser && npm install -g .` to install your local version globally.
+
 ### Output
 
 ```plaintext

package.json

@@ -1,6 +1,6 @@
 {
   "name": "protoml-parser",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "ProtoML is a lightweight, declarative markup language designed for writing and structuring meeting protocols, notes and task lists in a human-readable and machine-parseable format.",
   "keywords": [
     "protoml",
@@ -17,16 +17,30 @@
     "protoparser": "bin/protoparser.js"
   },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build:exe": "pkg . --out-path dist"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Ente/protoml-parser.git"
   },
   "author": "Ente",
+  "pkg": {
+    "scripts": "bin/protoparser.js",
+    "assets": [
+      "src/renders/themes/*"
+    ],
+    "targets": [
+      "node18-win-x64",
+      "node18-linux-x64"
+    ]
+  },
   "license": "GPL-3.0-or-later",
   "bugs": {
     "url": "https://github.com/Ente/protoml-parser/issues"
   },
-  "homepage": "https://github.com/Ente/protoml-parser#readme"
+  "homepage": "https://github.com/Ente/protoml-parser#readme",
+  "devDependencies": {
+    "pkg": "^5.8.1"
+  }
 }