📚 Update docs (#1)

* 📚 Updates readme to community addons

* 📚 update docs and screenshots

* 📚 🎨 fix links and update screenshots

* 📚 🔨 fix links

* 📚 update link and tagline

* 📚 update tagline
This commit is contained in:
Timmo 2018-12-12 16:09:39 +00:00 committed by GitHub
parent a222b49475
commit 6a251777ee
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 167 additions and 121 deletions

218
README.md
View file

@ -1,4 +1,4 @@
# Timmo Hass.io Add-ons: Home Panel
# Community Hass.io Add-ons: Home Panel
[![GitHub Release][releases-shield]][releases]
![Project Stage][project-stage-shield]
@ -9,44 +9,32 @@
[![GitHub Activity][commits-shield]][commits]
[![Bountysource][bountysource-shield]][bountysource]
[![Discord][discord-shield]][discord]
[![Community Forum][forum-shield]][forum]
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
[Home Panel][home-panel] add-on
[![Support my work on Patreon][patreon-shield]][patreon]
A touch-compatible web frontend for controlling the home.
## About
A touch-compatible web-app for controlling the home. Integrates with
[Home Assistant][hass] as an alternative / additional frontend.
A touch-compatible web frontend for controlling the home. Integrates with
[Home Assistant][hass] as an alternative / additional frontend. Uses a
customisable and themeable card based UI which can be used on a touch screen.
![banner][banner]
## Features
- Card based user interface with support for [Home Assistant][hass]
- Supports MJPEG and related image-based camera/image feeds. Images can also
be used
- Light control with brightness, temperature, color and effects support
- Supports Radio playback from TuneIn
- Add weather and weather icons using Home Assistant's
[Dark Sky](https://www.home-assistant.io/components/weather.darksky/)
component
- Made for touch screens with a sideways scrolling Material
Design interface. (Compatible with desktops as well)
- Customizable interface
- Custom theme support
## Screenshots
![Light Theme Screenshot][light-theme]
![More Info Light Screenshot][more-info-light]
![Midnight Theme Screenshot][midnight-theme]
![Dark Theme Screenshot][dark-theme]
![More Info Dark Screenshot][more-info-dark]
![More Info Light Screenshot][more-info-light]
![Radio Screenshot][radio]
![Forest Theme][theme-forest]
![Forest Theme Screenshot][forest-theme]
## Installation
@ -54,24 +42,43 @@ The installation of this add-on is pretty straightforward and not different in
comparison to installing any other Hass.io add-on.
1. [Add our Hass.io add-ons repository][repository] to your Hass.io instance.
1. Install the "Home Panel" add-on
1. Configure the "Home Panel" add-on (See below)
1. Start the "Home Panel" add-on
1. Install the "Home Panel" add-on.
1. Configure the "Home Panel" add-on. (See below)
1. Start the "Home Panel" add-on.
1. Check the logs of the "Home Panel" add-on to see it in action.
1. Surf to your Hass.io instance and use port `8234`
(e.g. `https://hassio.local:8234`).
1. Create a new account.
1. Once logged in, There will be a prompt to login to Home Assistant.
**NOTE**: Do not add this repository to Hass.io, please use:
`https://github.com/timmo001/repository`.
`https://github.com/hassio-addons/repository`.
## Docker status
![Supports armhf Architecture][armhf-shield]
![Supports aarch64 Architecture][aarch64-shield]
![Supports amd64 Architecture][amd64-shield]
![Supports i386 Architecture][i386-shield]
[![Docker Architecture][armhf-arch-shield]][armhf-dockerhub]
[![Docker Version][armhf-version-shield]][armhf-microbadger]
[![Docker Layers][armhf-layers-shield]][armhf-microbadger]
[![Docker Pulls][armhf-pulls-shield]][armhf-dockerhub]
[![Anchore Image Overview][armhf-anchore-shield]][armhf-anchore]
[![Docker Version][version-shield]][microbadger]
[![Docker Layers][layers-shield]][microbadger]
[![Docker Pulls][pulls-shield]][dockerhub]
[![Docker Architecture][aarch64-arch-shield]][aarch64-dockerhub]
[![Docker Version][aarch64-version-shield]][aarch64-microbadger]
[![Docker Layers][aarch64-layers-shield]][aarch64-microbadger]
[![Docker Pulls][aarch64-pulls-shield]][aarch64-dockerhub]
[![Anchore Image Overview][aarch64-anchore-shield]][aarch64-anchore]
[![Docker Architecture][amd64-arch-shield]][amd64-dockerhub]
[![Docker Version][amd64-version-shield]][amd64-microbadger]
[![Docker Layers][amd64-layers-shield]][amd64-microbadger]
[![Docker Pulls][amd64-pulls-shield]][amd64-dockerhub]
[![Anchore Image Overview][amd64-anchore-shield]][amd64-anchore]
[![Docker Architecture][i386-arch-shield]][i386-dockerhub]
[![Docker Version][i386-version-shield]][i386-microbadger]
[![Docker Layers][i386-layers-shield]][i386-microbadger]
[![Docker Pulls][i386-pulls-shield]][i386-dockerhub]
[![Anchore Image Overview][i386-anchore-shield]][i386-anchore]
## Configuration
@ -109,7 +116,7 @@ you are troubleshooting.
### Option: `ssl`
Enables/Disables SSL (HTTPS) on the IDE. Set it `true` to enable it,
Enables/Disables SSL (HTTPS) on the app. Set it `true` to enable it,
`false` otherwise.
### Option: `certfile`
@ -148,7 +155,18 @@ based on the following:
## Support
You can [open an issue here][issue] on GitHub.
Got questions?
You have several options to get them answered:
- The [Community Hass.io Add-ons Discord chat server][discord] for add-on
support and feature requests.
- The [Home Assistant Discord chat server][discord-ha] for general Home
Assistant discussions and questions.
- The Home Assistant [Community Forum][forum].
- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]
You could also [open an issue here][issue] on GitHub.
## Contributing
@ -162,7 +180,7 @@ Thank you for being involved! :heart_eyes:
## Authors & contributors
The original setup of this repository is by [Timmo][Timmo].
The original setup of this repository is by [Franck Nijhof][frenck].
For a full list of all authors and contributors,
check [the contributor's page][contributors].
@ -178,65 +196,93 @@ our [GitHub Repository][repository].
MIT License
Copyright (c) Timmo
Copyright (c) 2018 Franck Nijhof
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
[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
[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
[anchore-shield]: https://anchore.io/service/badges/image/8f74a497abc908834244d697a67675ecd13080199270598283c8e0cea1b1723e
[bountysource-shield]: https://img.shields.io/bountysource/team/timmo001/activity.svg
[bountysource]: https://www.bountysource.com/teams/timmo/issues
[commits-shield]: https://img.shields.io/github/commit-activity/y/timmo001/addon-home-panel.svg
[commits]: https://github.com/timmo001/addon-home-panel/commits/master
[contributors]: https://github.com/timmo001/addon-home-panel/graphs/contributors
[dockerhub]: https://hub.docker.com/r/timmo001/addon-home-panel
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
[timmo]: https://github.com/timmo001
[gitlabci-shield]: https://gitlab.com/timmo/addon-home-panel/badges/master/pipeline.svg
[gitlabci]: https://gitlab.com/timmo/addon-home-panel/pipelines
[issue]: https://github.com/timmo001/addon-home-panel/issues
[keepchangelog]: http://keepachangelog.com/en/1.0.0/
[layers-shield]: https://images.microbadger.com/badges/image/timmo001/addon-home-panel.svg
[license-shield]: https://img.shields.io/github/license/timmo001/addon-home-panel.svg
[maintenance-shield]: https://img.shields.io/maintenance/yes/2018.svg
[microbadger]: https://microbadger.com/images/timmo001/addon-home-panel
[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
[pulls-shield]: https://img.shields.io/docker/pulls/timmo001/addon-home-panel.svg
[reddit]: https://reddit.com/r/homeassistant
[releases-shield]: https://img.shields.io/github/release/timmo001/addon-home-panel.svg
[releases]: https://github.com/timmo001/addon-home-panel/releases
[aarch64-anchore-shield]: https://anchore.io/service/badges/image/3a52e98fc35e238711880453f882da1578f46af2019f705077a1202b633c2b21
[aarch64-anchore]: https://anchore.io/image/dockerhub/hassioaddons%2Fhome-panel-aarch64%3Alatest
[aarch64-arch-shield]: https://img.shields.io/badge/architecture-aarch64-blue.svg
[aarch64-dockerhub]: https://hub.docker.com/r/hassioaddons/home-panel-aarch64
[aarch64-layers-shield]: https://images.microbadger.com/badges/image/hassioaddons/home-panel-aarch64.svg
[aarch64-microbadger]: https://microbadger.com/images/hassioaddons/home-panel-aarch64
[aarch64-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/home-panel-aarch64.svg
[aarch64-version-shield]: https://images.microbadger.com/badges/version/hassioaddons/home-panel-aarch64.svg
[alpine-packages]: https://pkgs.alpinelinux.org/packages
[amd64-anchore-shield]: https://anchore.io/service/badges/image/f7a8fc048af61c13119239a4411cead2cf775029eb09f7af3e0a2f5183d0669a
[amd64-anchore]: https://anchore.io/image/dockerhub/hassioaddons%home-panel-amd64%3Alatest
[amd64-arch-shield]: https://img.shields.io/badge/architecture-amd64-blue.svg
[amd64-dockerhub]: https://hub.docker.com/r/hassioaddons/home-panel-amd64
[amd64-layers-shield]: https://images.microbadger.com/badges/image/hassioaddons/home-panel-amd64.svg
[amd64-microbadger]: https://microbadger.com/images/hassioaddons/home-panel-amd64
[amd64-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/home-panel-amd64.svg
[amd64-version-shield]: https://images.microbadger.com/badges/version/hassioaddons/home-panel-amd64.svg
[armhf-anchore-shield]: https://anchore.io/service/badges/image/8299a0af4020e22be2a2dd91dbc84e39babeae5178680278d51881ffba88d949
[armhf-anchore]: https://anchore.io/image/dockerhub/hassioaddons%2Fhome-panel-armhf%3Alatest
[armhf-arch-shield]: https://img.shields.io/badge/architecture-armhf-blue.svg
[armhf-dockerhub]: https://hub.docker.com/r/hassioaddons/home-panel-armhf
[armhf-layers-shield]: https://images.microbadger.com/badges/image/hassioaddons/home-panel-armhf.svg
[armhf-microbadger]: https://microbadger.com/images/hassioaddons/home-panel-armhf
[armhf-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/home-panel-armhf.svg
[armhf-version-shield]: https://images.microbadger.com/badges/version/hassioaddons/home-panel-armhf.svg
[bountysource-shield]: https://img.shields.io/bountysource/team/hassio-addons/activity.svg
[bountysource]: https://www.bountysource.com/teams/hassio-addons/issues
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg
[buymeacoffee]: https://www.buymeacoffee.com/timmo
[repository]: https://github.com/timmo001/repository
[semver]: http://semver.org/spec/v2.0.0.html
[version-shield]: https://images.microbadger.com/badges/version/timmo001/addon-home-panel.svg
[home-panel]: https://github.com/timmo001/home-panel
[light-theme]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/light-theme.png
[dark-theme]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/dark-theme.png
[buymeacoffee]: https://www.buymeacoffee.com/frenck
[commits-shield]: https://img.shields.io/github/commit-activity/y/hassio-addons/addon-home-panel.svg
[commits]: https://github.com/hassio-addons/addon-home-panel/commits/master
[contributors]: https://github.com/hassio-addons/addon-home-panel/graphs/contributors
[discord-ha]: https://discord.gg/c5DvZ4e
[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
[discord]: https://discord.me/hassioaddons
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
[forum]: https://community.home-assistant.io/t/home-panel-a-touch-compatible-webapp-for-controlling-the-home/62597?u=timmo001
[frenck]: https://github.com/frenck
[gitlabci-shield]: https://gitlab.com/hassio-addons/addon-home-panel/badges/master/pipeline.svg
[gitlabci]: https://gitlab.com/hassio-addons/addon-home-panel/pipelines
[home-assistant]: https://home-assistant.io
[i386-anchore-shield]: https://anchore.io/service/badges/image/491da5d9a64e7173746bce5053145c57199e81cbc87f0dfbea9bcab1186b91db
[i386-anchore]: https://anchore.io/image/dockerhub/hassioaddons%2Fhome-panel-i386%3Alatest
[i386-arch-shield]: https://img.shields.io/badge/architecture-i386-blue.svg
[i386-dockerhub]: https://hub.docker.com/r/hassioaddons/home-panel-i386
[i386-layers-shield]: https://images.microbadger.com/badges/image/hassioaddons/home-panel-i386.svg
[i386-microbadger]: https://microbadger.com/images/hassioaddons/home-panel-i386
[i386-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/home-panel-i386.svg
[i386-version-shield]: https://images.microbadger.com/badges/version/hassioaddons/home-panel-i386.svg
[issue]: https://github.com/hassio-addons/addon-home-panel/issues
[keepchangelog]: http://keepachangelog.com/en/1.0.0/
[license-shield]: https://img.shields.io/github/license/hassio-addons/addon-home-panel.svg
[maintenance-shield]: https://img.shields.io/maintenance/yes/2018.svg
[patreon-shield]: https://www.frenck.nl/images/patreon.png
[patreon]: https://www.patreon.com/frenck
[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
[reddit]: https://reddit.com/r/homeassistant
[releases-shield]: https://img.shields.io/github/release/hassio-addons/addon-home-panel.svg
[releases]: https://github.com/hassio-addons/addon-home-panel/releases
[repository]: https://github.com/hassio-addons/repository
[semver]: http://semver.org/spec/v2.0.0.htm
[home-panel]: https://git.timmo.xyz/home-panel
[midnight-theme]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/midnight-theme.png
[forest-theme]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/forest-theme.png
[more-info-light]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/more-info-light.png
[more-info-dark]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/more-info-dark.png
[radio]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/radio.png
[hass]: https://www.home-assistant.io/
[docs]: https://git.timmo.xyz/home-panel/
[config]: https://git.timmo.xyz/home-panel/configuration/
[theme-forest]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/theme-forest.png
[banner]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/banner.png

View file

@ -1,39 +1,33 @@
# Timmo Hass.io Add-ons: Home Panel
# Community Hass.io Add-ons: Pi-hole
[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield]
[Home Panel][home-panel] add-on
[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum]
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
[![Support my work on Patreon][patreon-shield]][patreon]
A touch-compatible web frontend for controlling the home.
## About
A touch-compatible web-app for controlling the home. Integrates with
[Home Assistant][hass] as an alternative / additional frontend.
### Features
- Card based user interface with support for [Home Assistant][hass]
- Supports MJPEG and related image-based camera/image feeds. Images can also
be used
- Light control with brightness, temperature, color and effects support
- Supports Radio playback from TuneIn
- Add weather and weather icons using Home Assistant's
[Dark Sky](https://www.home-assistant.io/components/weather.darksky/)
component
- Made for touch screens with a sideways scrolling Material
Design interface. (Compatible with desktops as well)
- Customizable interface
- Custom theme support
A touch-compatible web frontend for controlling the home. Integrates with
[Home Assistant][hass] as an alternative / additional frontend. Uses a
customisable and themeable card based UI which can be used on a touch screen.
[Click here for the full documentation][docs]
### Screenshots
![Light Theme Screenshot][light-theme]
![Midnight Theme Screenshot][midnight-theme]
![More Info Dark Screenshot][more-info-dark]
![More Info Light Screenshot][more-info-light]
![Forest Theme][theme-forest]
[Click here for the full documentation][docs]
{% if channel == "edge" %}
## WARNING! THIS IS AN EDGE VERSION!
@ -52,7 +46,7 @@ This repository was created for:
If you are more interested in stable releases of our add-ons:
<https://github.com/timmo001/repository>
<https://github.com/hassio-addons/repository>
{% endif %}
{% if channel == "beta" %}
@ -68,21 +62,27 @@ This repository was created for:
- Anybody willing to test.
- Anybody interested in trying out upcoming add-ons or add-on features.
If you are more interested in stable releases of Timmo add-ons:
If you are more interested in stable releases of our add-ons:
<https://github.com/timmo001/repository>
<https://github.com/hassio-addons/repository>
{% endif %}
[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg
[buymeacoffee]: https://www.buymeacoffee.com/frenck
[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
[discord]: https://discord.me/hassioaddons
[docs]: {{ repo }}/blob/{{ version }}/README.md
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
[forum]: https://community.home-assistant.io/t/home-panel-a-touch-compatible-webapp-for-controlling-the-home/62597?u=timmo001
[maintenance-shield]: https://img.shields.io/maintenance/yes/2018.svg
[patreon-shield]: https://www.frenck.nl/images/patreon.png
[patreon]: https://www.patreon.com/frenck
[pi-hole]: https://pi-hole.net/
[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
[release-shield]: https://img.shields.io/badge/version-{{ version }}-blue.svg
[release]: {{ repo }}/tree/{{ version }}
[docs]: {{ repo }}/blob/{{ version }}/README.md
[hass]: https://www.home-assistant.io/
[home-panel]: https://github.com/timmo001/home-panel
[light-theme]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/light-theme.png
[dark-theme]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/dark-theme.png
[midnight-theme]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/midnight-theme.png
[more-info-light]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/more-info-light.png
[more-info-dark]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/more-info-dark.png
[radio]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/radio.png
[theme-forest]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/theme-forest.png

View file

@ -40,12 +40,12 @@ ARG BUILD_VERSION
# Labels
LABEL \
io.hass.name="Home Panel" \
io.hass.description="A touch-compatible web-app for controlling the home" \
io.hass.description="A touch-compatible web frontend for controlling the home." \
io.hass.arch="${BUILD_ARCH}" \
io.hass.type="addon" \
io.hass.version=${BUILD_VERSION} \
maintainer="Timmo <contact@timmo.xyz>" \
org.label-schema.description="A touch-compatible web-app for controlling the home" \
org.label-schema.description="A touch-compatible web frontend for controlling the home." \
org.label-schema.build-date=${BUILD_DATE} \
org.label-schema.name="Home Panel" \
org.label-schema.schema-version="1.0" \

View file

@ -2,8 +2,8 @@
"name": "Home Panel",
"version": "dev",
"slug": "home-panel",
"description": "A touch-compatible web-app for controlling the home",
"url": "https://github.com/timmo001/addon-home-panel",
"description": "A touch-compatible web frontend for controlling the home.",
"url": "https://github.com/hassio-addons/addon-home-panel",
"webui": "[PROTO:ssl]://[HOST]:[PORT:8234]",
"startup": "application",
"arch": [