Skip to content

Commit

Permalink
almond: Split documentation (home-assistant#1293)
Browse files Browse the repository at this point in the history
  • Loading branch information
frenck authored and ericmatte committed May 24, 2020
1 parent c6aa32d commit a96f748
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 39 deletions.
40 changes: 40 additions & 0 deletions almond/DOCS.md
@@ -0,0 +1,40 @@
# Home Assistant Add-on: Almond

## Installation

Follow these steps to get the add-on installed on your system:

1. Navigate in your Home Assistant frontend to **Supervisor** -> **Add-on Store**.
2. Find the "Almond" add-on and click it.
3. Click on the "INSTALL" button.

## How to use

The basic thing to get the add-on running would be:

1. Start the add-on.
2. Go the the Home Assistant frontend -> **Configuration** -> **Integrations**
to configure Home Assistant to use this add-on. After starting,
it will be automatically discovered by Home Assistant.

## Configuration

This add-on has no additional configuration options.

## Support

Got questions?

You have several options to get them answered:

- The [Home Assistant Discord Chat Server][discord].
- The Home Assistant [Community Forum][forum].
- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]

In case you've found a bug, please [open an issue on our GitHub][issue].

[discord]: https://discord.gg/c5DvZ4e
[forum]: https://community.home-assistant.io
[issue]: https://github.com/home-assistant/hassio-addons/issues
[reddit]: https://reddit.com/r/homeassistant
[repository]: https://github.com/hassio-addons/repository
40 changes: 1 addition & 39 deletions almond/README.md
Expand Up @@ -4,49 +4,11 @@

![Supports aarch64 Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] ![Supports armhf Architecture][armhf-shield] ![Supports armv7 Architecture][armv7-shield] ![Supports i386 Architecture][i386-shield]

## About

## Installation

Follow these steps to get the add-on installed on your system:

1. Navigate in your Home Assistant frontend to **Supervisor** -> **Add-on Store**.
2. Find the "Almond" add-on and click it.
3. Click on the "INSTALL" button.

## How to use

The basic thing to get the add-on running would be:

1. Start the add-on.
2. Go the the Home Assistant frontend -> **Configuration** -> **Integrations**
to configure Home Assistant to use this add-on. After starting,
it will be automatically discovered by Home Assistant.

## Configuration

This add-on has no additional configuration options.

## Support

Got questions?

You have several options to get them answered:

- The [Home Assistant Discord Chat Server][discord].
- The Home Assistant [Community Forum][forum].
- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]

In case you've found a bug, please [open an issue on our GitHub][issue].
The Open, Privacy-Preserving Virtual Assistant.

[Almond]: https://almond.stanford.edu/
[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
[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
[discord]: https://discord.gg/c5DvZ4e
[forum]: https://community.home-assistant.io
[i386-shield]: https://img.shields.io/badge/i386-no-red.svg
[issue]: https://github.com/home-assistant/hassio-addons/issues
[reddit]: https://reddit.com/r/homeassistant
[repository]: https://github.com/hassio-addons/repository

0 comments on commit a96f748

Please sign in to comment.