diff --git a/README.md b/README.md index 84c5047c5..0d3009b3c 100644 --- a/README.md +++ b/README.md @@ -2,25 +2,25 @@ ## First private cloud solution for home automation -Hass.io is a Docker-based system for managing your Home Assistant installation -and related applications. The system is controlled via Home Assistant which -communicates with the Supervisor. The Supervisor provides an API to manage the -installation. This includes changing network settings or installing -and updating software. +Home Assistant (former Hass.io) is a container-based system for managing your +Home Assistant Core installation and related applications. The system is +controlled via Home Assistant which communicates with the Supervisor. The +Supervisor provides an API to manage the installation. This includes changing +network settings or installing and updating software. ## Installation -Installation instructions can be found at . +Installation instructions can be found at https://home-assistant.io/hassio. ## Development -The development of the supervisor is a bit tricky. Not difficult but tricky. +The development of the Supervisor is not difficult but tricky. -- You can use the builder to build your supervisor: https://github.com/home-assistant/hassio-builder -- Go into a HassOS device or VM and pull your supervisor. -- Set the developer modus with cli `hassio supervisor options --channel=dev` +- You can use the builder to create your Supervisor: https://github.com/home-assistant/hassio-builder +- Access a HassOS device or VM and pull your Supervisor. +- Set the developer modus with the CLI tool: `ha supervisor options --channel=dev` - Tag it as `homeassistant/xy-hassio-supervisor:latest` -- Restart the service like `systemctl restart hassos-supervisor | journalctl -fu hassos-supervisor` +- Restart the service with `systemctl restart hassos-supervisor | journalctl -fu hassos-supervisor` - Test your changes -Small Bugfix or improvements, make a PR. Significant change makes first an RFC. +For small bugfixes or improvements, make a PR. For significant changes open a RFC first, please. Thanks.