Updated CI and readme

.github/workflows/ci.yml

@@ -2,13 +2,16 @@ name: ci
 
 on:
   push:
-    branches:
-      - master
+    tags:
+      - "v*"
 
-# Checkout the code and zip the mesh_to_pcd folder as a build artifact
 jobs:
   build:
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      packages: write
+      actions: write
 
     steps:
     - uses: actions/checkout@v4
@@ -20,4 +23,11 @@ jobs:
       uses: actions/upload-artifact@v4
       with:
         name: mesh_to_pcd
-        path: mesh_to_pcd.zip
+        path: mesh_to_pcd.zip
+
+    - name: Create a release
+      uses: marvinpinto/action-automatic-releases@latest
+      with:
+        repo_token: ${{ secrets.GITHUB_TOKEN }}
+        prerelease: false
+        files: mesh_to_pcd.zip

README.md

@@ -2,4 +2,16 @@
 
 Blender script to convert a mesh with a principled BRDF material with a base color or a texture into a colored point cloud using Poisson Disk sampling.
 
-<img src="docs/images/mesh.png" alt="mesh" height="200"/><img src="docs/images/pcd.png" alt="point cloud" height="200"/>
+![mesh](docs/images/mesh.png)![point cloud](docs/images/pcd.png)
+
+## Installation
+
+Download the `mesh_to_pcd.zip` file from the [latest release](https://github.com/cjaverliat/MeshToPointCloud/releases). In Blender go to `Edit > Preferences > Add-ons`, click `Install...` and select the zip file. Confirm the install by clicking on `Install Add-on` and enable the addon from the list.
+
+![addons](docs/images/addons.png)
+
+## Usage
+
+Select one or several meshes, open the contextual menu and run `Export Mesh To Point Cloud`. A dialog will appear asking for the parameters for the output directory and the Poisson Disk Sampling operations.
+
+![parameters](docs/images/parameters.png)