Skip to content

Commit

Permalink
📚 Add My buttons to documentation (#134)
Browse files Browse the repository at this point in the history
  • Loading branch information
frenck authored Mar 14, 2022
1 parent 9dd95fa commit 3623a8f
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 3 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ It detects Chromecast players in your network and creates virtual AirPlay
devices for each of them. It acts as a bridge between the AirPlay client
and the real Chromecast player.

The AirCast add-on is based on the excellent [AirConnect][airconnect] project.

[:books: Read the full add-on documentation][docs]

## Support
Expand Down Expand Up @@ -99,6 +101,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
Expand Down
3 changes: 3 additions & 0 deletions aircast/.README.j2
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ It detects Chromecast players in your network and creates virtual AirPlay
devices for each of them. It acts as a bridge between the AirPlay client
and the real Chromecast player.

The AirCast add-on is based on the excellent [AirConnect][airconnect] project.

{% if channel == "edge" %}
## WARNING! THIS IS AN EDGE VERSION!

Expand Down Expand Up @@ -59,6 +61,7 @@ If you are more interested in stable releases of our add-ons:
<https://github.com/hassio-addons/repository>

{% 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
Expand Down
22 changes: 19 additions & 3 deletions aircast/DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,32 @@ It detects Chromecast players in your network and creates virtual AirPlay
devices for each of them. It acts as a bridge between the AirPlay client
and the real Chromecast player.

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 “AirCast” add-on in the Supervisor add-on store
and install it.
1. Install the "AirCast" add-on.
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 "AirCast" add-on
1. Check the logs of the "AirCast" add-on to see if everything went well.

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._
Expand Down Expand Up @@ -219,6 +230,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_airconnect
[airconnect]: https://github.com/philippe44/AirConnect
[contributors]: https://github.com/hassio-addons/addon-aircast/graphs/contributors
[discord-ha]: https://discord.gg/c5DvZ4e
[discord]: https://discord.me/hassioaddons
Expand All @@ -228,4 +242,6 @@ SOFTWARE.
[issue]: https://github.com/hassio-addons/addon-aircast/issues
[reddit]: https://reddit.com/r/homeassistant
[releases]: https://github.com/hassio-addons/addon-aircast/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%2Fgh.neting.cc%2Fhassio-addons%2Frepository
[semver]: http://semver.org/spec/v2.0.0.htm

0 comments on commit 3623a8f

Please sign in to comment.