Merge pull request #28 from kevinschweikert/features/doc-improvements

isponsorblocktv/DOCS.md

@@ -16,4 +16,35 @@ rm -rf /tmp/config && mkdir /tmp/config && docker run --rm -it -v /tmp/config:/a
 
 You can then pick the bits out that you need.
 
+The config file will look something like this:
+
+```json
+{
+    "devices": [
+        {
+            "screen_id": "[YOUR SCREEN-ID]",
+            "name": "YouTube on TV",
+            "offset": 0
+        }
+    ],
+    "apikey": "",
+    "skip_categories": [
+        "sponsor"
+    ],
+    "channel_whitelist": [],
+    "skip_count_tracking": true,
+    "mute_ads": false,
+    "skip_ads": true
+}
+```
+
+You can then transfer the device config over to a YAML config which looks like this:
+
+```yml
+- screen_id: [YOUR SCREEN-ID]
+  name: LG TV
+```
+
+
+
 You must also set a YouTube API key as apikey.

isponsorblocktv/config.yaml

@@ -20,18 +20,18 @@ options:
   mute_ads: false
   skip_ads: true
 schema:
-  apikey: "str"
+  apikey: password
   devices:
-    - name: "str?"
-      screen_id: "str"
-      offset: "int?"
+    - name: str?
+      screen_id: str
+      offset: int?
   channel_whitelist:
-    - id: "str"
-    - name: "str"
+    - id: str
+    - name: str
   skip_categories:
-    - match(^.*(sponsor|selfpromo|exclusive_access|interaction|poi_highlight|intro|outro|preview|filler|music_offtopic).*$)
-  skip_count_tracking: "bool"
-  mute_ads: "bool"
-  skip_ads: "bool"
+    - list(sponsor|selfpromo|exclusive_access|interaction|poi_highlight|intro|outro|preview|filler|music_offtopic)
+  skip_count_tracking: bool
+  mute_ads: bool
+  skip_ads: bool
 image: "ghcr.io/bertybuttface/{arch}-addon-isponsorblocktv"
 host_network: true