Simplify add-on files (#18)

example/CHANGELOG.md

@@ -2,18 +2,8 @@
 
 ## 1.1.0
 
-- Add configuration options
-- Add labels to the docker image
-- Install tempio in the docker image to show how args can be used
-
-## 1.0.1
-
-- Use yaml for config and build files
+- Updates
 
 ## 1.0.0
 
-- Complete refresh of all files
-
-## 0.1.0
-
 - Initial release

example/DOCS.md

@@ -1,13 +1,5 @@
 # Home Assistant Add-on: Example add-on
 
-## Installation
-
-Follow these steps to get the add-on installed on your system:
-
-1. Navigate in your Home Assistant frontend to **Supervisor** -> **Add-on Store**.
-1. Find the "Example add-on" add-on and click it.
-1. Click on the "INSTALL" button.
-
 ## How to use
 
 This add-on really does nothing. It is just an example.

example/Dockerfile

@@ -8,5 +8,5 @@ RUN \
     curl -sSLf -o /usr/bin/tempio \
     "https://github.com/home-assistant/tempio/releases/download/${TEMPIO_VERSION}/tempio_${BUILD_ARCH}"
 
-# Copy data
+# Copy root filesystem
 COPY rootfs /

example/README.md

@@ -8,10 +8,8 @@ _Example add-on to use as a blueprint for new add-ons._
 ![Supports armv7 Architecture][armv7-shield]
 ![Supports i386 Architecture][i386-shield]
 
-
-
 [aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
 [amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
 [armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
 [armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
-[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
+[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg

example/rootfs/etc/services.d/example/finish

@@ -1,6 +1,7 @@
 #!/usr/bin/execlineb -S1
 # ==============================================================================
 # Take down the S6 supervision tree when example fails
+# s6-overlay docs: https://github.com/just-containers/s6-overlay
 # ==============================================================================
 if { s6-test ${1} -ne 0 }
 if { s6-test ${1} -ne 256 }

example/rootfs/etc/services.d/example/run

@@ -1,18 +1,19 @@
 #!/usr/bin/with-contenv bashio
 # ==============================================================================
 # Start the example service
+# s6-overlay docs: https://github.com/just-containers/s6-overlay
 # ==============================================================================
 
 # Add your code here
 
+# Declare variables
+declare message
+
 ## Get the 'message' key from the user config options.
-CONFIG_MESSAGE=$(bashio::config 'message')
+message=$(bashio::config 'message')
 
-## Set the message to be printed, defaults to "Hello World..."
-PRINT_MESSAGE=${CONFIG_MESSAGE:="Hello World..."}
-
-## Print the message the user supplied
-bashio::log.info "${PRINT_MESSAGE}"
+## Print the message the user supplied, defaults to "Hello World..."
+bashio::log.info "${message:="Hello World..."}"
 
 ## Run your program
 # exec my_program --with-params