From 95f018eff9c94e00ec85eea937d8ea0476db4056 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Mon, 14 Mar 2022 13:54:16 +0100 Subject: [PATCH] :books: Add My buttons to documentation (#112) --- README.md | 3 +++ airsonos/.README.j2 | 3 +++ airsonos/DOCS.md | 21 +++++++++++++++++++-- 3 files changed, 25 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c1dfddf..5940a03 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,8 @@ and the real Sonos device. Since Sonos uses UPnP, the add-on might also work for other UPnP players (e.g., newer Samsung televisions). +The AirCast add-on is based on the excellent [AirConnect][airconnect] project. + [:books: Read the full add-on documentation][docs] ## Support @@ -102,6 +104,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. [aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg +[airconnect]: https://github.com/philippe44/AirConnect [amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg [armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg [armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg diff --git a/airsonos/.README.j2 b/airsonos/.README.j2 index bff95b6..582a0d8 100644 --- a/airsonos/.README.j2 +++ b/airsonos/.README.j2 @@ -23,6 +23,8 @@ and the real Sonos device. Since Sonos uses UPnP, the add-on might also work for other UPnP players (e.g., newer Samsung televisions). +The AirCast add-on is based on the excellent [AirConnect][airconnect] project. + {% if channel == "edge" %} ## WARNING! THIS IS AN EDGE VERSION! @@ -62,6 +64,7 @@ If you are more interested in stable releases of our add-ons: {% endif %} +[airconnect]: https://github.com/philippe44/AirConnect [discord-shield]: https://img.shields.io/discord/478094546522079232.svg [discord]: https://discord.me/hassioaddons [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg diff --git a/airsonos/DOCS.md b/airsonos/DOCS.md index 22defb9..29789dc 100644 --- a/airsonos/DOCS.md +++ b/airsonos/DOCS.md @@ -11,13 +11,19 @@ and the real Sonos device. Since Sonos uses UPnP, the add-on might also work for other UPnP players (e.g., newer Samsung televisions). +The AirCast add-on is based on the excellent [AirConnect][airconnect] project. + ## 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 “AirSonos” 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 "AirSonos" add-on 1. Check the logs of the "AirSonos" add-on to see if everything went well. @@ -25,6 +31,12 @@ After ~30 seconds you should see some log messages appear in the add-on log. Using your iOS/Mac/iTunes/Airfoil/other clients, you should now see new AirPlay devices and can try to play audio to them. +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._ @@ -233,6 +245,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_airsonos +[airconnect]: https://github.com/philippe44/AirConnect [commits]: https://github.com/hassio-addons/addon-airsonos/commits/main [contributors]: https://github.com/hassio-addons/addon-airsonos/graphs/contributors [discord-ha]: https://discord.gg/c5DvZ4e @@ -242,4 +257,6 @@ SOFTWARE. [issue]: https://github.com/hassio-addons/addon-airsonos/issues [reddit]: https://reddit.com/r/homeassistant [releases]: https://github.com/hassio-addons/addon-airsonos/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