add github release workflow and restructure readme

Author: csteuer

.github/workflows/package.yml

@@ -0,0 +1,21 @@
+name: Package
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [master, main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Create Plugin ZIP
+        run: ./create_plugin_zip.sh
+
+      - uses: actions/upload-artifact@v4
+        with:
+          path: codebarista_revocationbutton_*.zip
+          if-no-files-found: error

.github/workflows/release.yml

@@ -0,0 +1,29 @@
+name: Publish
+
+permissions:
+  contents: write
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build:
+    name: Publish Plugin ZIP
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Create Plugin ZIP
+      run: ./create_plugin_zip.sh
+
+    - name: Upload Plugin ZIP to release
+      uses: svenstaro/upload-release-action@v2
+      with:
+        repo_token: ${{ secrets.GITHUB_TOKEN }}
+        file: codebarista_revocationbutton_*.zip
+        file_glob: true
+        tag: ${{ github.ref }}
+        overwrite: true

README.md

@@ -1,7 +1,12 @@
 # Revocation Button for Shopware 6.4 / 6.5
 
-A Shopware plugin that adds the legally mandated revocation button to the storefont.
-This basically backports the native Shopware 6.6/6.7 implementation to Shopware 6.4/6.5.
+A Shopware plugin that adds the legally mandated revocation button to the storefront,
+similar to the native Shopware 6.6/6.7 implementation.
+
+## Compatibility
+
+- PHP 7.4+ / 8.x
+- Shopware `~6.4.12 || ~6.5.0`
 
 ## What it does
 
@@ -12,7 +17,19 @@ This basically backports the native Shopware 6.6/6.7 implementation to Shopware
   - `codebarista_revocation_request.customer` — confirmation to the customer.
   Both can be customised under *Settings → Email templates*.
 
-## Adding the revocation link to the storefront
+## How to use it
+
+> [!IMPORTANT]
+> Always test new plugin versions in a dev environment before using them in a production/live shop.
+
+1. Download the ZIP archive from the latest [release](https://github.com/codebarista-de/revocationbutton/releases).
+2. Log in to the Admin UI of your shop and go to `Extensions > My extensions`.
+3. Click `Upload extension` and select the downloaded ZIP archive.
+4. Find the `Revocation Button` extension in the list.
+5. Install and activate it.
+
+
+### Adding the revocation link to the storefront
 
 The plugin does not auto-inject the link, so you keep full control over
 placement, label and visibility. To add the link the same way imprint and
@@ -23,7 +40,7 @@ privacy are exposed:
 3. **Admin → Sales Channels → (your channel) → Service menu** — add the new category to the service-menu category tree.
 4. Save and clear caches. The link now appears in the footer service menu next to *Imprint* / *Privacy*.
 
-## Configuration
+### Configuration
 
 Configure under *Settings → Plugins → Revocation Button → Configure*.
 All fields are optional — sensible fallbacks apply when left empty.
@@ -35,11 +52,6 @@ All fields are optional — sensible fallbacks apply when left empty.
 | Outgoing mail – From: address | merchant inbox address | `From:` used for **both** outgoing mails (notification + customer confirmation). |
 | Outgoing mail – From: display name | sales channel name | `From:` display name used for **both** outgoing mails. |
 
-## Compatibility
-
-- PHP 7.4+ / 8.x
-- Shopware `~6.4.12 || ~6.5.0`
-
 ## License
 
 MIT — see [LICENSE](LICENSE).

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "codebarista/revocationbutton",
   "version": "1.0.0",
-  "description": "Backports the Shopware 6.6/6.7 revocation request form to Shopware 6.4/6.5 so EU shops can comply with the legally mandated revocation button.",
+  "description": "Revocation button for Shopware 6.4/6.5.",
   "type": "shopware-platform-plugin",
   "license": "MIT",
   "keywords": ["shopware", "shopware-plugin", "revocation", "withdrawal", "widerruf", "eu", "compliance"],

create_plugin_zip.sh

@@ -0,0 +1,23 @@
+#!/bin/sh
+
+set -e
+set -v
+
+version=$(jq -r ".version" < composer.json)
+root_folder="RevocationButton"
+filename="codebarista_revocationbutton_$version.zip"
+out_file="$PWD/$filename"
+
+rm -rf "/tmp/$root_folder"
+mkdir -p "/tmp/$root_folder"
+cp -r . "/tmp/$root_folder/"
+
+rm -f "$out_file"
+
+( cd /tmp && zip -r "$out_file" "$root_folder" \
+ -x "$root_folder/.*" \
+ -x "$root_folder/*.xcf" \
+ -x "$root_folder/bin*" \
+ -x "$root_folder/*.sh" \
+ -x "$root_folder/*.zip" \
+ -x "$root_folder/*.md")