feat: client types (#36)

.github/workflows/clients-check-pull-request.yaml

@@ -19,5 +19,5 @@ jobs:
 
     - name: Test if we can generate clients
       run: |
-        go install github.com/awesome-jellyfin/clients-md-generator/cmd/generate@b6f86c42190bce8717d9524a4b73ba86e9a49d1c
+        go install github.com/awesome-jellyfin/clients-md-generator/cmd/generate@c6c44360024954a72a46617421c297aca4a2565e
-        generate -input assets/clients/clients.yaml
+        generate -input assets/clients/clients.yaml -check-icons

.github/workflows/clients-update-clients.yaml

@@ -26,7 +26,7 @@ jobs:
 
     - name: Generate CLIENTS.md
       run: |
-        go install github.com/awesome-jellyfin/clients-md-generator/cmd/generate@b6f86c42190bce8717d9524a4b73ba86e9a49d1c
+        go install github.com/awesome-jellyfin/clients-md-generator/cmd/generate@c6c44360024954a72a46617421c297aca4a2565e
         generate -input assets/clients/clients.yaml -out-file assets/clients/generated-clients.md
 
         echo "" > CLIENTS.md

assets/clients/CLIENTS.template.md

@@ -11,15 +11,19 @@ To make changes, please edit the `assets/clients/clients.yaml` file and regenera
   <h1 align="center"><a href="https://github.com/awesome-jellyfin/awesome-jellyfin">Awesome Jellyfin</a> > Clients</h1>
 </p>
 
+{{ CLIENTS }}
+
+---
+
 > [!NOTE]
 > Please note that this Markdown file is automatically generated from the [`clients.yaml`](./assets/clients/clients.yaml) file. 
 > **Contributions should only be made by updating the `clients.yaml` file.** 
 > Any updates to the `.yaml` file will result in this Markdown file being re-generated to reflect those changes.
 
-{{ CLIENTS }}
+<!--
+⚠️ WARNING: DO NOT EDIT THIS FILE ⚠️
 
----
+This Markdown file is auto-generated from the `assets/clients/clients.yaml` file. 
-
+Any manual changes made to this file will be overwritten the next time it is generated. 
-* Music Client ` 🎵 `
+To make changes, please edit the `assets/clients/clients.yaml` file and regenerate this Markdown file.
-* Early Release / BETA software ` 🛠️ `
+-->
-* Official ` 🔹 `

assets/clients/clients.yaml

@@ -370,3 +370,22 @@ targets:
         mapped: "Roku"
       - name: WebOS
         mapped: "webOS"
+
+types:
+  # dummy type for official badge
+  - key: Official
+    badge: "🔹"
+
+  # dummy type for beta badge
+  - key: Beta
+    badge: "⚒️"
+
+  - key: Music
+    badge: "🎵"
+    display: Music Client
+    section: true
+
+  - key: Reader
+    badge: "📖"
+    display: Reader
+    section: true