v2.3.1 release

.github/workflows/main.yml

@@ -32,17 +32,3 @@ jobs:
         with:
           name: Build Products
           path: dist
-
-      # Commit the build results to the branch
-      # Commit will fail if files are unchanged
-      #- name: Commit Build Artifacts in dist
-      #  run: |
-      #    git config --local user.email "[email protected]"
-      #    git config --local user.name "GitHub Action"
-      #    git add dist/*
-      #    git diff-index --quiet HEAD || git commit -m "Build PhysX-JS-WebIDL"
-
-      #- name: Push Changes to Branch
-      #  uses: ad-m/github-push-action@master
-      #  with:
-      #    github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -0,0 +1,38 @@
+name: PhysX-JS-WebIDL - Release Library
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  build:
+    name: Build PhysX-JS-WebIDL
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        with:
+          lfs: true
+          submodules: recursive
+
+      - name: Set up Docker Compose
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y docker-compose
+      
+      - name: Build Docker Environment
+        run: sudo docker compose up
+
+      - name: Build PhysX-JS-WebIDL
+        run: sudo docker compose run --rm builder ./make.sh
+
+      - name: Create release
+        uses: ncipollo/release-action@v1
+        with:
+          allowUpdates: true
+          artifacts: "dist/*"
+          draft: true
+          updateOnlyUnreleased: true

README.md

@@ -3,6 +3,18 @@ Javascript/WASM bindings for Nvidia PhysX 5.3.1.
 
 Looking for pre-built binaries / build instructions? See [below](#pre-built-binaries)
 
+## Library coverage
+
+The bindings include most major parts of the PhysX SDK (excluding CUDA stuff, which is not possible with WASM):
+- [x] Basics
+    - Static and dynamic actors
+    - All geometry types (box, capsule, sphere, plane, convex mesh, triangle mesh and height field)
+- [x] All joint types (revolute, spherical, prismatic, fixed, distance and D6)
+- [x] Articulations
+- [x] Vehicles
+- [x] Character controllers
+- [x] Scene serialization
+
 ## Getting started
 There is a basic [hello world example](dist/helloworld.html): 10 boxes falling on the ground (drawn as wireframe on a plain canvas).
 
@@ -32,11 +44,12 @@ This library is published as a npm package:
 ```
 npm i physx-js-webidl
 ```
-Alternatively you can grab the pre-built binaries (.wasm + support .js) from the `dist` directory.
+Alternatively you can grab the pre-built binaries (.wasm + support .js) from the latest [Release](https://github.com/fabmax/physx-js-webidl/releases).
 
 ## Building
 In order to build the library you need a recent version of the [emscripten SDK](https://emscripten.org/docs/getting_started/downloads.html) - I'm
 using version `3.1.51`. Alternatively, you can use docker as described below.
+After successful build, the binaries (.wasm + support .js) will appear in the `dist` directory.
 
 ```
 # Clone this repo

dist/README.md

@@ -3,6 +3,18 @@ Javascript/WASM bindings for Nvidia PhysX 5.3.1.
 
 Looking for pre-built binaries / build instructions? See [below](#pre-built-binaries)
 
+## Library coverage
+
+The bindings include most major parts of the PhysX SDK (excluding CUDA stuff, which is not possible with WASM):
+- [x] Basics
+    - Static and dynamic actors
+    - All geometry types (box, capsule, sphere, plane, convex mesh, triangle mesh and height field)
+- [x] All joint types (revolute, spherical, prismatic, fixed, distance and D6)
+- [x] Articulations
+- [x] Vehicles
+- [x] Character controllers
+- [x] Scene serialization
+
 ## Getting started
 There is a basic [hello world example](dist/helloworld.html): 10 boxes falling on the ground (drawn as wireframe on a plain canvas).
 
@@ -32,11 +44,12 @@ This library is published as a npm package:
 ```
 npm i physx-js-webidl
 ```
-Alternatively you can grab the pre-built binaries (.wasm + support .js) from the `dist` directory.
+Alternatively you can grab the pre-built binaries (.wasm + support .js) from the latest [Release](https://github.com/fabmax/physx-js-webidl/releases).
 
 ## Building
 In order to build the library you need a recent version of the [emscripten SDK](https://emscripten.org/docs/getting_started/downloads.html) - I'm
 using version `3.1.51`. Alternatively, you can use docker as described below.
+After successful build, the binaries (.wasm + support .js) will appear in the `dist` directory.
 
 ```
 # Clone this repo