:docs: Update docs

This commit is contained in:
Timmo 2019-08-31 23:57:04 +01:00
parent 2b7cd697f6
commit cbff72ebdd
4 changed files with 14 additions and 25 deletions

View file

@ -19,11 +19,11 @@
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee] [![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
A touch-compatible web frontend for controlling the home. A web frontend for controlling the home.
## About ## About
A touch-compatible web frontend for controlling the home. Integrates with A web frontend for controlling the home. Integrates with
[Home Assistant][hass] as an alternative / additional frontend. Uses a [Home Assistant][hass] as an alternative / additional frontend. Uses a
customisable and themeable card based UI which can be used on a touch screen. customisable and themeable card based UI which can be used on a touch screen.
@ -33,9 +33,7 @@ A touch-compatible web frontend for controlling the home. Integrates with
![Midnight Theme Screenshot][midnight-theme] ![Midnight Theme Screenshot][midnight-theme]
![More Info Light Screenshot][more-info-light] ![Settings Screenshot][settings-screen]
![Forest Theme Screenshot][forest-theme]
## Installation ## Installation
@ -47,10 +45,9 @@ comparison to installing any other Hass.io add-on.
1. Configure the "Home Panel" add-on. (See below) 1. Configure the "Home Panel" add-on. (See below)
1. Start the "Home Panel" add-on. 1. Start the "Home Panel" add-on.
1. Check the logs of the "Home Panel" add-on to see it in action. 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` 1. Click "Open Web UI".
(e.g. `https://hassio.local:8234`).
1. Create a new account. 1. Create a new account.
1. Once logged in, There will be a prompt to login to Home Assistant. 1. Once logged in, log into Home Assistant via the sidebar.
1. Please see [here][config] for how to configure Home Panel 1. Please see [here][config] for how to configure Home Panel
**NOTE**: Do not add this repository to Hass.io, please use: **NOTE**: Do not add this repository to Hass.io, please use:
@ -199,7 +196,6 @@ SOFTWARE.
[discord]: https://discord.me/hassioaddons [discord]: https://discord.me/hassioaddons
[dockerhub]: https://hub.docker.com/r/hassioaddons/home-panel [dockerhub]: https://hub.docker.com/r/hassioaddons/home-panel
[docs]: https://timmo.dev/home-panel/ [docs]: https://timmo.dev/home-panel/
[forest-theme]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/forest-theme.png
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg [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 [forum]: https://community.home-assistant.io/t/home-panel-a-touch-compatible-webapp-for-controlling-the-home/62597?u=timmo001
[gitlabci-shield]: https://gitlab.com/hassio-addons/addon-home-panel/badges/master/pipeline.svg [gitlabci-shield]: https://gitlab.com/hassio-addons/addon-home-panel/badges/master/pipeline.svg
@ -213,11 +209,11 @@ SOFTWARE.
[license-shield]: https://img.shields.io/github/license/hassio-addons/addon-home-panel.svg [license-shield]: https://img.shields.io/github/license/hassio-addons/addon-home-panel.svg
[maintenance-shield]: https://img.shields.io/maintenance/yes/2019.svg [maintenance-shield]: https://img.shields.io/maintenance/yes/2019.svg
[midnight-theme]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/midnight-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
[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg [project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
[reddit]: https://reddit.com/r/homeassistant [reddit]: https://reddit.com/r/homeassistant
[releases-shield]: https://img.shields.io/github/release/hassio-addons/addon-home-panel.svg [releases-shield]: https://img.shields.io/github/release/hassio-addons/addon-home-panel.svg
[releases]: https://github.com/hassio-addons/addon-home-panel/releases [releases]: https://github.com/hassio-addons/addon-home-panel/releases
[repository]: https://github.com/hassio-addons/repository [repository]: https://github.com/hassio-addons/repository
[semver]: http://semver.org/spec/v2.0.0.htm [semver]: http://semver.org/spec/v2.0.0.htm
[settings-screen]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/settings-main.png
[timmo]: https://github.com/timmo001 [timmo]: https://github.com/timmo001

View file

@ -6,23 +6,17 @@
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee] [![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
A touch-compatible web frontend for controlling the home. A web frontend for controlling the home. Integrates with
## About
A touch-compatible web frontend for controlling the home. Integrates with
[Home Assistant][hass] as an alternative / additional frontend. Uses a [Home Assistant][hass] as an alternative / additional frontend. Uses a
customisable and themeable card based UI which can be used on a touch screen. customisable and themeable card based UI which can be used on a touch screen.
[Click here for the full documentation][docs] ![banner][banner]
### Screenshots ## Screenshots
![Midnight Theme Screenshot][midnight-theme] ![Midnight Theme Screenshot][midnight-theme]
![More Info Light Screenshot][more-info-light] ![Settings Screenshot][settings-screen]
![Forest Theme Screenshot][forest-theme]
[Click here for the full documentation][docs] [Click here for the full documentation][docs]
@ -71,14 +65,13 @@ If you are more interested in stable releases of our add-ons:
[discord-shield]: https://img.shields.io/discord/478094546522079232.svg [discord-shield]: https://img.shields.io/discord/478094546522079232.svg
[discord]: https://discord.me/hassioaddons [discord]: https://discord.me/hassioaddons
[docs]: {{ repo }}/blob/{{ version }}/README.md [docs]: {{ repo }}/blob/{{ version }}/README.md
[forest-theme]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/forest-theme.png
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg [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 [forum]: https://community.home-assistant.io/t/home-panel-a-touch-compatible-webapp-for-controlling-the-home/62597?u=timmo001
[hass]: https://www.home-assistant.io/ [hass]: https://www.home-assistant.io/
[home-panel]: https://github.com/timmo001/home-panel [home-panel]: https://github.com/timmo001/home-panel
[maintenance-shield]: https://img.shields.io/maintenance/yes/2019.svg [maintenance-shield]: https://img.shields.io/maintenance/yes/2019.svg
[midnight-theme]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/midnight-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
[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg [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-shield]: https://img.shields.io/badge/version-{{ version }}-blue.svg
[release]: {{ repo }}/tree/{{ version }} [release]: {{ repo }}/tree/{{ version }}
[settings-screen]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/settings-main.png

View file

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

View file

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