diff --git a/README.md b/README.md index 970e8af..d9bf0f5 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,8 @@ A 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. +[:books: Read the full add-on documentation][docs] + ![banner][banner] ## Screenshots @@ -37,86 +39,6 @@ A web frontend for controlling the home. Integrates with ![Showcase Purple Space][showcase-purple-space] -## Installation - -The installation of this add-on is pretty straightforward and not different in -comparison to installing any other Home Assistant 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. Check the logs of the "Home Panel" add-on to see it in action. -1. Click "Open Web UI". -1. Create a new account. -1. Once logged in, log into Home Assistant via the sidebar. -1. Please see [here][config] for how to configure Home Panel - -**NOTE**: Do not add this repository to Hass.io, please use: -`https://github.com/hassio-addons/repository`. - -## Configuration - -**Note**: _Remember to restart the add-on when the configuration is changed._ - -Example add-on configuration: - -```yaml -log_level: info -ssl: true -certfile: fullchain.pem -keyfile: privkey.pem -``` - -### Option: `log_level` - -The `log_level` option controls the level of log output by the addon and can -be changed to be more or less verbose, which might be useful when you are -dealing with an unknown issue. Possible values are: - -- `trace`: Show every detail, like all called internal functions. -- `debug`: Shows detailed debug information. -- `info`: Normal (usually) interesting events. -- `warning`: Exceptional occurrences that are not errors. -- `error`: Runtime errors that do not require immediate action. -- `fatal`: Something went terribly wrong. Add-on becomes unusable. - -Please note that each level automatically includes log messages from a -more severe level, e.g., `debug` also shows `info` messages. By default, -the `log_level` is set to `info`, which is the recommended setting unless -you are troubleshooting. - -### Option: `ssl` - -Enables/Disables SSL (HTTPS) on the app. Set it `true` to enable it, -`false` otherwise. - -### Option: `certfile` - -The certificate file to use for SSL. - -**Note**: _The file MUST be stored in `/ssl/`, which is the default_ - -### Option: `keyfile` - -The private key file to use for SSL. - -**Note**: _The file MUST be stored in `/ssl/`, which is the default_ - -## Changelog & Releases - -This repository keeps a change log using [GitHub's releases][releases] -functionality. The format of the log is based on -[Keep a Changelog][keepchangelog]. - -Releases are based on [Semantic Versioning][semver], and use the format -of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented -based on the following: - -- ``MAJOR``: Incompatible or major changes. -- ``MINOR``: Backwards-compatible new features and enhancements. -- ``PATCH``: Backwards-compatible bugfixes and package updates. - ## Support Got questions? @@ -194,18 +116,14 @@ SOFTWARE. [discord-ha]: https://discord.gg/c5DvZ4e [discord-shield]: https://img.shields.io/discord/478094546522079232.svg [discord]: https://discord.me/hassioaddons -[dockerhub]: https://hub.docker.com/r/hassioaddons/home-panel -[docs]: https://timmo.dev/home-panel/ +[docs]: https://github.com/hassio-addons/addon-home-panel/blob/master/home-panel/DOCS.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 [gitlabci-shield]: https://gitlab.com/hassio-addons/addon-home-panel/badges/master/pipeline.svg [gitlabci]: https://gitlab.com/hassio-addons/addon-home-panel/pipelines [hass]: https://www.home-assistant.io/ -[home-assistant]: https://home-assistant.io -[home-panel]: https://timmo.dev/home-panel [i386-shield]: https://img.shields.io/badge/i386-yes-green.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/2020.svg [project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg @@ -215,6 +133,5 @@ SOFTWARE. [repository]: https://github.com/hassio-addons/repository [screen-configuration-main]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/screen-configuration-main.png [screen-main]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/screen-main.png -[semver]: http://semver.org/spec/v2.0.0.htm [showcase-purple-space]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/docs/showcase/timmo/purple-space.png [timmo]: https://github.com/timmo001 diff --git a/home-panel/.README.j2 b/home-panel/.README.j2 index 764fee3..1ca939e 100644 --- a/home-panel/.README.j2 +++ b/home-panel/.README.j2 @@ -20,8 +20,6 @@ A web frontend for controlling the home. Integrates with ![Showcase Purple Space][showcase-purple-space] -[Click here for the full documentation][docs] - {% if channel == "edge" %} ## WARNING! THIS IS AN EDGE VERSION! @@ -67,7 +65,6 @@ If you are more interested in stable releases of our add-ons: [buymeacoffee]: https://www.buymeacoffee.com/timmo [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 [hass]: https://www.home-assistant.io/ diff --git a/home-panel/DOCS.md b/home-panel/DOCS.md new file mode 100644 index 0000000..2a0410d --- /dev/null +++ b/home-panel/DOCS.md @@ -0,0 +1,143 @@ +# Home Assistant Community Add-on: Home Panel + +A 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. + +## Installation + +The installation of this add-on is pretty straightforward and not different in +comparison to installing any other Home Assistant add-on. + +1. Search for the "Home Assistant” add-on in the add-on store and install it. +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. Click "Open Web UI". +1. Create a new account. +1. Once logged in, log into Home Assistant via the sidebar. +1. Please see [here][config] for how to configure Home Panel + +## Configuration + +**Note**: _Remember to restart the add-on when the configuration is changed._ + +Example add-on configuration: + +```yaml +log_level: info +ssl: true +certfile: fullchain.pem +keyfile: privkey.pem +``` + +### Option: `log_level` + +The `log_level` option controls the level of log output by the addon and can +be changed to be more or less verbose, which might be useful when you are +dealing with an unknown issue. Possible values are: + +- `trace`: Show every detail, like all called internal functions. +- `debug`: Shows detailed debug information. +- `info`: Normal (usually) interesting events. +- `warning`: Exceptional occurrences that are not errors. +- `error`: Runtime errors that do not require immediate action. +- `fatal`: Something went terribly wrong. Add-on becomes unusable. + +Please note that each level automatically includes log messages from a +more severe level, e.g., `debug` also shows `info` messages. By default, +the `log_level` is set to `info`, which is the recommended setting unless +you are troubleshooting. + +### Option: `ssl` + +Enables/Disables SSL (HTTPS) on the app. Set it `true` to enable it, +`false` otherwise. + +### Option: `certfile` + +The certificate file to use for SSL. + +**Note**: _The file MUST be stored in `/ssl/`, which is the default_ + +### Option: `keyfile` + +The private key file to use for SSL. + +**Note**: _The file MUST be stored in `/ssl/`, which is the default_ + +## Changelog & Releases + +This repository keeps a change log using [GitHub's releases][releases] +functionality. The format of the log is based on +[Keep a Changelog][keepchangelog]. + +Releases are based on [Semantic Versioning][semver], and use the format +of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented +based on the following: + +- ``MAJOR``: Incompatible or major changes. +- ``MINOR``: Backwards-compatible new features and enhancements. +- ``PATCH``: Backwards-compatible bugfixes and package updates. + +## Support + +Got questions? + +You have several options to get them answered: + +- The [Home Assistant Community 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. + +## Authors & contributors + +The original setup of this repository is by [Timmo][timmo]. + +For a full list of all authors and contributors, +check [the contributor's page][contributors]. + +## License + +MIT License + +Copyright (c) 2018-2020 Timmo + +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: + +The above copyright notice and this permission notice shall be included in all +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. + +[config]: https://timmo.dev/home-panel/configui/ +[contributors]: https://github.com/hassio-addons/addon-home-panel/graphs/contributors +[discord-ha]: https://discord.gg/c5DvZ4e +[discord]: https://discord.me/hassioaddons +[docs]: https://timmo.dev/home-panel/ +[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/ +[home-panel]: https://timmo.dev/home-panel +[issue]: https://github.com/hassio-addons/addon-home-panel/issues +[keepchangelog]: http://keepachangelog.com/en/1.0.0/ +[reddit]: https://reddit.com/r/homeassistant +[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 +[timmo]: https://github.com/timmo001