Merge pull request #25 from dala318/make-repository-hacs-compliant

Make repository HACS compliant

Author: dala318

.github/FUNDING.yml

@@ -0,0 +1,4 @@
+
+# These are supported funding model platforms
+
+patreon: Dala318

.github/workflows/hacs.yaml

@@ -0,0 +1,15 @@
+name: HACS Action
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  hacs:
+    name: HACS Action
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: HACS Action
+        uses: "hacs/action@main"
+        with:
+          category: "integration"

.github/workflows/hassfest.yaml

@@ -0,0 +1,14 @@
+name: Validate with hassfest
+
+on:
+  push:
+  pull_request:
+  # schedule:
+  #   - cron: "0 0 * * *"
+
+jobs:
+  validate:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: actions/checkout@v4
+      - uses: home-assistant/actions/hassfest@master

.github/workflows/release.yaml

@@ -0,0 +1,35 @@
+name: "Release"
+
+on:
+  release:
+    types:
+      - "published"
+
+permissions: {}
+
+jobs:
+  release:
+    name: "Release"
+    runs-on: "ubuntu-latest"
+    permissions:
+      contents: write
+    steps:
+      - name: "Checkout the repository"
+        uses: "actions/checkout@v4"
+
+      - name: "Adjust version number"
+        shell: "bash"
+        run: |
+          yq -i -o json '.version="${{ github.event.release.tag_name }}"' \
+            "${{ github.workspace }}/custom_components/ph803w/manifest.json"
+
+      - name: "ZIP the integration directory"
+        shell: "bash"
+        run: |
+          cd "${{ github.workspace }}/custom_components/ph803w"
+          zip ph803w.zip -r ./
+
+      - name: "Upload the ZIP file to the release"
+        uses: softprops/action-gh-release@v2.0.8
+        with:
+          files: ${{ github.workspace }}/custom_components/ph803w/ph803w.zip

README.md

@@ -4,17 +4,25 @@ With a lot of inspiration and help from https://github.com/Apollon77/node-ph803w
 Still a lot left to do but at least it can poll the device and show values in Home Assistant.
 In desktop mode (running cyclic with lib/main.py) it performs a bit better.
 
-## Installation of HA component
+# Installation
 
-1. Clone this repo as `ph803w` dir into `$HA_CONFIG_DIR/custom_components/`
-   ```
-   $ cd custom_components
-   $ git clone git@github.com:dala318/ph803w.git ./ph803w
-   ```
-2. Setup `$HA_CONFIG_DIR/configuration.yaml`
+## Option 1: HACS
+1. Go to HACS -> Integrations
+2. Click the three dots on the top right and select `Custom Repositories`
+3. Enter `https://github.com/dala318/python_ph803w` as repository, select the category `Integration` and click Add
+4. A new custom integration shows up for installation (PH-803W) - install it
+5. Restart Home Assistant
+
+## Option 2: Manual
+
+1. Copy the `ph803w` folder to HA `<config_dir>/custom_components/ph803w/`
+2. Restart Home Assistant
+
+# Configuration
+
+Setup `$HA_CONFIG_DIR/configuration.yaml`
 
 ```yaml
 ph803w:
   host: 192.168.1.2    # IP of your device
 ```
-## Changelog