From fbd359fb04f36015571f357531b4e8bc2dee66e2 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Mon, 7 Mar 2022 21:03:15 +0100 Subject: [PATCH] :books: Add My buttons to documentation (#307) * :books: Add My buttons to documentation * :books: Add My buttons to documentation --- adguard/DOCS.md | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/adguard/DOCS.md b/adguard/DOCS.md index 92191ca..bb11441 100644 --- a/adguard/DOCS.md +++ b/adguard/DOCS.md @@ -1,9 +1,9 @@ # Home Assistant Community Add-on: AdGuard Home -AdGuard Home is a network-wide ad-and-tracker blocking DNS server with -parental control (adult content blocking) capabilities. Its purpose is to let -you control your entire network and all your devices, and it does not require -using a client-side program. +[AdGuard Home][adguard] is a network-wide ad-and-tracker blocking DNS server +with parental control (adult content blocking) capabilities. Its purpose is to +let you control your entire network and all your devices, and it does not +require using a client-side program. AdGuard Home provides a beautiful, easy and feature-rich web interface to easily manage the filtering process and its settings. @@ -20,13 +20,23 @@ comparison to installing any other Home Assistant add-on. [![Open your Home Assistant instance and show your Supervisor system information.](https://my.home-assistant.io/badges/supervisor_info.svg)](https://my.home-assistant.io/redirect/supervisor_info/) (_Host → IP Address → Change → IPv4 → Static_) - Please note, setting a fixed IP in your router is **NOT** static. -1. Search for the "AdGuard Home" add-on in the Supervisor add-on store and - install it. +1. Click the Home Assistant My button below to open the add-on on your Home + Assistant instance. + + [![Open this add-on in your Home Assistant instance.][addon-badge]][addon] + +1. Click the "Install" button to install the add-on. 1. Start the "AdGuard Home" add-on. 1. Check the logs of the "AdGuard Home" to see if everything went well. 1. Click the "OPEN WEB UI" button and log in with your Home Assistant account. 1. Ready to go! +Home Assistant, by default, ships with the Community Add-ons store installed. +However, if it is missing (for any reason), you can add it by clicking the +button My button below. + +[!Add repository to your Home Assitant instance.][repository-badge]][repository] + ## Configuration **Note**: _Remember to restart the add-on when the configuration is changed._ @@ -155,6 +165,9 @@ 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. +[addon-badge]: https://my.home-assistant.io/badges/supervisor_addon.svg +[addon]: https://my.home-assistant.io/redirect/supervisor_addon/?addon=a0d7b954_adguard +[adguard]: https://adguard.com/en/adguard-home/overview.html [contributors]: https://github.com/hassio-addons/addon-adguard-home/graphs/contributors [discord-ha]: https://discord.gg/c5DvZ4e [discord]: https://discord.me/hassioaddons @@ -163,4 +176,6 @@ SOFTWARE. [issue]: https://github.com/hassio-addons/addon-adguard-home/issues [reddit]: https://reddit.com/r/homeassistant [releases]: https://github.com/hassio-addons/addon-adguard-home/releases +[repository-badge]: https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg +[repository]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fhassio-addons%2Frepository [semver]: http://semver.org/spec/v2.0.0.htm