📚 update docs and screenshots

This commit is contained in:
Timmo 2018-12-12 11:53:24 +00:00 committed by GitHub
parent f9566d53e3
commit 4522f94162
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

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