✏️ Re-branding and updating for latest supervisor (home-assistant#1047)

thecem · Feb 5, 2020 · 684e197 · 684e197
1 parent 2f80548
commit 684e197
Show file tree

Hide file tree

Showing 20 changed files with 284 additions and 368 deletions.
diff --git a/ada/README.md b/ada/README.md
@@ -10,7 +10,7 @@ Voice assistant powered by Home Assistant.
 
 Follow these steps to get the add-on installed on your system:
 
-1. Navigate in your Home Assistant frontend to **Hass.io** -> **Add-on Store**.
+1. Navigate in your Home Assistant frontend to **Supervisor** -> **Add-on Store**.
 2. Find the "Hey Ada!" add-on and click it.
 3. Click on the "INSTALL" button.
 
@@ -26,11 +26,9 @@ The basic thing to get the add-on running would be:
 
 Example add-on configuration:
 
-```json
-{
-  "stt": "cloud",
-  "tts": "cloud"
-}
+```yaml
+stt: cloud
+tts: cloud
 ```
 
 ### Option: `stt` (required)

diff --git a/almond/README.md b/almond/README.md
@@ -10,7 +10,7 @@ Almond For Home Servers.
 
 Follow these steps to get the add-on installed on your system:
 
-1. Navigate in your Home Assistant frontend to **Hass.io** -> **Add-on Store**.
+1. Navigate in your Home Assistant frontend to **Supervisor** -> **Add-on Store**.
 2. Find the "Almond" add-on and click it.
 3. Click on the "INSTALL" button.
 

diff --git a/cec_scan/README.md b/cec_scan/README.md
@@ -13,7 +13,7 @@ the CEC address of your devices.
 
 Follow these steps to get the add-on installed on your system:
 
-1. Navigate in your Home Assistant frontend to **Hass.io** -> **Add-on Store**.
+1. Navigate in your Home Assistant frontend to **Supervisor** -> **Add-on Store**.
 2. Find the "CEC Scanner" add-on and click it.
 3. Click on the "INSTALL" button.
 

diff --git a/check_config/README.md b/check_config/README.md
@@ -15,7 +15,7 @@ resulting in a smooth update.
 
 Follow these steps to get the add-on installed on your system:
 
-1. Navigate in your Home Assistant frontend to **Hass.io** -> **Add-on Store**.
+1. Navigate in your Home Assistant frontend to **Supervisor** -> **Add-on Store**.
 2. Find the "Check Home Assistant configuration" add-on and click it.
 3. Click on the "INSTALL" button.
 
@@ -37,10 +37,8 @@ Home Assistant version.
 
 Add-on configuration:
 
-```json
-{
-  "version": "latest"
-}
+```yaml
+version: latest
 ```
 
 ### Option: `version` (required)

diff --git a/configurator/README.md b/configurator/README.md
@@ -34,7 +34,7 @@ configuration files) will be automatically checked for syntax errors while editi
 
 Follow these steps to get the add-on installed on your system:
 
-1. Navigate in your Home Assistant frontend to **Hass.io** -> **Add-on Store**.
+1. Navigate in your Home Assistant frontend to **Supervisor** -> **Add-on Store**.
 2. Find the "Configurator" add-on and click it.
 3. Click on the "INSTALL" button.
 
@@ -51,15 +51,12 @@ In general, this add-on requires no configuration from your end.
 
 Add-on configuration:
 
-```json
-{
-  "dirsfirst": false,
-  "enforce_basepath": false,
-  "ignore_pattern": [
-    "__pycache__"
-  ],
-  "ssh_keys": []
-}
+```yaml
+dirsfirst: false
+enforce_basepath: false
+ignore_pattern:
+  - __pycache__
+ssh_keys: []
 ```
 
 ### Option: `dirsfirst` (required)

diff --git a/deconz/README.md b/deconz/README.md
@@ -8,7 +8,7 @@ Control a Zigbee network using ConBee or RaspBee hardware by Dresden Elektronik.
 
 Follow these steps to get the add-on installed on your system:
 
-1. Navigate in your Home Assistant frontend to **Hass.io** -> **Add-on Store**.
+1. Navigate in your Home Assistant frontend to **Supervisor** -> **Add-on Store**.
 2. Find the "deCONZ" add-on and click it.
 3. Click on the "INSTALL" button.
 
@@ -140,22 +140,19 @@ These options require a number that represents the log level.
 
 Example add-on config with `dbg_aps` enabled on log level 1:
 
-```json
-{
-  "device": "/dev/ttyUSB0",
-  "vnc_password": "",
-  "dbg_aps": 1
-}
+```yaml
+device: /dev/ttyUSB0
+vnc_password: ""
+dbg_aps: 1
+
 ```
 
 ## Configuration
 
 Add-on configuration:
 
-```json
-{
-  "device": "/dev/ttyAMA0"
-}
+```yaml
+device: /dev/ttyAMA0
 ```
 
 ### Option: `device` (required)

diff --git a/dhcp_server/README.md b/dhcp_server/README.md
@@ -14,7 +14,7 @@ to ensure they always get assigned the same IP address.
 
 Follow these steps to get the add-on installed on your system:
 
-1. Navigate in your Home Assistant frontend to **Hass.io** -> **Add-on Store**.
+1. Navigate in your Home Assistant frontend to **Supervisor** -> **Add-on Store**.
 2. Find the "DHCP server" add-on and click it.
 3. Click on the "INSTALL" button.
 
@@ -31,31 +31,25 @@ describes each of the add-on configuration options.
 
 Example add-on configuration:
 
-```json
-{
-  "domain": "mynetwork.local",
-  "dns": ["8.8.8.8", "8.8.4.4"],
-  "default_lease": 86400,
-  "max_lease": 172800,
-  "networks": [
-    {
-      "subnet": "192.168.1.0",
-      "netmask": "255.255.255.0",
-      "range_start": "192.168.1.100",
-      "range_end": "192.168.1.200",
-      "broadcast": "192.168.1.255",
-      "gateway": "192.168.1.1",
-      "interface": "eth0"
-    }
-  ],
-  "hosts": [
-    {
-      "name": "webcam_xy",
-      "mac": "aa:bb:ee:cc",
-      "ip": "192.168.1.40"
-    }
-  ]
-}
+```yaml
+domain: mynetwork.local
+dns:
+  - 8.8.8.8
+  - 8.8.4.4
+default_lease: 86400
+max_lease: 172800
+networks:
+  - subnet: 192.168.1.0
+    netmask: 255.255.255.0
+    range_start: 192.168.1.100
+    range_end: 192.168.1.200
+    broadcast: 192.168.1.255
+    gateway: 192.168.1.1
+    interface: eth0
+hosts:
+  - name: webcam_xy
+    mac: aa:bb:ee:cc
+    ip: 192.168.1.40
 ```
 
 ### Option: `domain` (required)

diff --git a/dnsmasq/README.md b/dnsmasq/README.md
@@ -14,7 +14,7 @@ an internal address inside your network.
 
 Follow these steps to get the add-on installed on your system:
 
-1. Navigate in your Home Assistant frontend to **Hass.io** -> **Add-on Store**.
+1. Navigate in your Home Assistant frontend to **Supervisor** -> **Add-on Store**.
 2. Find the "Dnsmasq" add-on and click it.
 3. Click on the "INSTALL" button.
 
@@ -32,16 +32,16 @@ describes each of the add-on configuration options.
 
 Example add-on configuration:
 
-```json
-{
-  "defaults": ["8.8.8.8", "8.8.4.4"],
-  "forwards": [
-    {"domain": "mystuff.local", "server": "192.168.1.40"}
-  ],
-  "hosts": [
-    {"host": "home.mydomain.io", "ip": "192.168.1.10"}
-  ]
-}
+```yaml
+defaults:
+  - 8.8.8.8
+  - 8.8.4.4
+forwards:
+  - domain: mystuff.local
+    server: 192.168.1.40
+hosts:
+  - host: home.mydomain.io
+    ip: 192.168.1.10
 ```
 
 ### Option: `defaults` (required)

diff --git a/duckdns/README.md b/duckdns/README.md
@@ -12,7 +12,7 @@ Automatically update your Duck DNS IP address with integrated HTTPS support via
 
 Follow these steps to get the add-on installed on your system:
 
-1. Navigate in your Home Assistant frontend to **Hass.io** -> **Add-on Store**.
+1. Navigate in your Home Assistant frontend to **Supervisor** -> **Add-on Store**.
 2. Find the "DuckDNS" add-on and click it.
 3. Click on the "INSTALL" button.
 
@@ -29,17 +29,15 @@ Follow these steps to get the add-on installed on your system:
 
 Add-on configuration:
 
-```json
-{
-  "lets_encrypt": {
-    "accept_terms": true,
-    "certfile": "fullchain.pem",
-    "keyfile": "privkey.pem"
-  },
-  "token": "sdfj-2131023-dslfjsd-12321",
-  "domains": ["my-domain.duckdns.org"],
-  "seconds": 300
-}
+```yaml
+lets_encrypt:
+  accept_terms: true
+  certfile: fullchain.pem
+  keyfile: privkey.pem
+token: sdfj-2131023-dslfjsd-12321
+domains:
+  - my-domain.duckdns.org
+seconds: 300
 ```
 
 ### Option group `lets_encrypt`

diff --git a/git_pull/README.md b/git_pull/README.md
@@ -13,7 +13,7 @@ repository.
 
 Follow these steps to get the add-on installed on your system:
 
-1. Navigate in your Home Assistant frontend to **Hass.io** -> **Add-on Store**.
+1. Navigate in your Home Assistant frontend to **Supervisor** -> **Add-on Store**.
 2. Find the "Git pull" add-on and click it.
 3. Click on the "INSTALL" button.
 
@@ -40,36 +40,31 @@ to `true` and turning on "Start on boot."
 
 Add-on configuration:
 
-```json
-{
-  "git_branch": "master",
-  "git_command": "pull",
-  "git_remote": "origin",
-  "git_prune": "false",
-  "repository": "https://example.com/my_configs.git",
-  "auto_restart": false,
-  "restart_ignore": [
-    "ui-lovelace.yaml",
-    ".gitignore",
-    "exampledirectory/"
-  ],
-  "repeat": {
-    "active": false,
-    "interval": 300
-  },
-  "deployment_user": "",
-  "deployment_password": "",
-  "deployment_key": [
-"-----BEGIN RSA PRIVATE KEY-----",
-"MIIEowIBAAKCAQEAv3hUrCvqGZKpXQ5ofxTOuH6pYSOZDsCqPqmaGBdUzBFgauQM",
-"xDEcoODGHIsWd7t9meAFqUtKXndeiKjfP0MMKsttnDohL1kb9mRvHre4VUqMsT5F",
-"...",
-"i3RUtnIHxGi1NqknIY56Hwa3id2yk7cEzvQGAAko/t6PCbe20AfmSQczs7wDNtBD",
-"HgXRyIqIXHYk2+5w+N2eunURIBqCI9uWYK/r81TMR6V84R+XhtvM",
-"-----END RSA PRIVATE KEY-----"
-  ],
-  "deployment_key_protocol": "rsa"
-}
+```yaml
+git_branch: master
+git_command: pull
+git_remote: origin
+git_prune: 'false'
+repository: https://example.com/my_configs.git
+auto_restart: false
+restart_ignore:
+  - ui-lovelace.yaml
+  - ".gitignore"
+  - exampledirectory/
+repeat:
+  active: false
+  interval: 300
+deployment_user: ''
+deployment_password: ''
+deployment_key:
+  - "-----BEGIN RSA PRIVATE KEY-----"
+  - MIIEowIBAAKCAQEAv3hUrCvqGZKpXQ5ofxTOuH6pYSOZDsCqPqmaGBdUzBFgauQM
+  - xDEcoODGHIsWd7t9meAFqUtKXndeiKjfP0MMKsttnDohL1kb9mRvHre4VUqMsT5F
+  - "..."
+  - i3RUtnIHxGi1NqknIY56Hwa3id2yk7cEzvQGAAko/t6PCbe20AfmSQczs7wDNtBD
+  - HgXRyIqIXHYk2+5w+N2eunURIBqCI9uWYK/r81TMR6V84R+XhtvM
+  - "-----END RSA PRIVATE KEY-----"
+deployment_key_protocol: rsa
 ```
 
 ### Option: `git_remote` (required)

diff --git a/google_assistant/README.md b/google_assistant/README.md
@@ -16,7 +16,7 @@ If you want to integrate your Google Home or mobile phone running Google Assista
 
 Follow these steps to get the add-on installed on your system:
 
-1. Navigate in your Home Assistant frontend to **Hass.io** -> **Add-on Store**.
+1. Navigate in your Home Assistant frontend to **Supervisor** -> **Add-on Store**.
 2. Find the "Google Assistant SDK" add-on and click it.
 3. Click on the "INSTALL" button.
 
@@ -49,12 +49,10 @@ The next step is to authenticate your Google account with Google Assistant. Star
 
 Add-on configuration:
 
-```json
-{
-  "client_secrets": "google_assistant.json",
-  "project_id": "project_id_from_google",
-  "model_id": "model_id_from_google"
-}
+```yaml
+client_secrets: google_assistant.json
+project_id: project_id_from_google
+model_id: model_id_from_google
 ```
 
 ### Option: `clients_secrets` (required)