diff --git a/docs/ABOUT.md b/docs/ABOUT.md index 66c4365..5f8061f 100644 --- a/docs/ABOUT.md +++ b/docs/ABOUT.md @@ -6,54 +6,54 @@ Add the _addon_'s Github [repository](http://github.com/dcmartin/hassio-addons) The Supervisor _Dashboard_ displays any installed _addons_ with indications for status and upgrade. - + The Supervisor _Add-on store_ displays _addons_ available from configured repositories. - + Additional repositories may be added (n.b control element, upper-right corner) - + For example: `http://github.com/dcmartin/hassio-addons` - + The _addons_ from the added repository are displayed in the _Add-on store_: - + ## Step 2: Install `ambianic` Install the _addon_ and the Home Assistant supervisor will download the appropriate Docker container from [Docker Hub](http://hub.docker.com/); for example the [`armv7`](https://hub.docker.com/repository/docker/dcmartin/armv7-addon-ambianic) version for RaspberryPi. - + After installation -- which may require significant time depending on network speed -- the _addon_ should be configured with the _sources_ and other options and started. See the [DOCS.md](../DOCS.md) file for more information on configuration options. - + When an update to an _addon_ is available, a notification is provided. - + ## Step 3: Browse to `ui.ambianic.ai` The Ambianic Edge software communicates using `WebRTC` to a progressive Web application (PWA) that provides the user-interface. The PWA provides for _settings_ to establish the peer-to-peer (P2P) connection between the edge device and the Web browser. Using a Web browser, navigate to `https://ui.ambianic.ai` (**note**: `SSL/TLS`) and the PWA will load and provide access to the controls (n.b. on the left-side). - + The PWA connects to the edge device through a redezvous on the local area network (LAN) requiring both the Web browser and the edge device to be on the same LAN for initiation. - + Once the P2P connection is established it will be maintained even when the Web browser is not on the same LAN. - + The PWA provides a _timeline_ of _events_, e.g. `Object Detection`, and displays them chronologically with the latest at the top. - + diff --git a/docs/dcmartin-addons.png b/docs/dcmartin-addons.png deleted file mode 100644 index 0592e2c..0000000 Binary files a/docs/dcmartin-addons.png and /dev/null differ diff --git a/docs/ambianic-addon-installed.png b/docs/samples/ambianic-addon-installed.png similarity index 100% rename from docs/ambianic-addon-installed.png rename to docs/samples/ambianic-addon-installed.png diff --git a/docs/ambianic-addon-not-installed.png b/docs/samples/ambianic-addon-not-installed.png similarity index 100% rename from docs/ambianic-addon-not-installed.png rename to docs/samples/ambianic-addon-not-installed.png diff --git a/docs/ambianic-addon-update-available.png b/docs/samples/ambianic-addon-update-available.png similarity index 100% rename from docs/ambianic-addon-update-available.png rename to docs/samples/ambianic-addon-update-available.png diff --git a/docs/ambianic-pwa-controls.png b/docs/samples/ambianic-pwa-controls.png similarity index 100% rename from docs/ambianic-pwa-controls.png rename to docs/samples/ambianic-pwa-controls.png diff --git a/docs/ambianic-pwa-operational.png b/docs/samples/ambianic-pwa-operational.png similarity index 100% rename from docs/ambianic-pwa-operational.png rename to docs/samples/ambianic-pwa-operational.png diff --git a/docs/ambianic-pwa-settings-complete.png b/docs/samples/ambianic-pwa-settings-complete.png similarity index 100% rename from docs/ambianic-pwa-settings-complete.png rename to docs/samples/ambianic-pwa-settings-complete.png diff --git a/docs/ambianic-pwa-settings-start.png b/docs/samples/ambianic-pwa-settings-start.png similarity index 100% rename from docs/ambianic-pwa-settings-start.png rename to docs/samples/ambianic-pwa-settings-start.png diff --git a/docs/supervisor-add-on-store-repositories.png b/docs/supervisor-add-on-store-repositories.png deleted file mode 100644 index c04bf59..0000000 Binary files a/docs/supervisor-add-on-store-repositories.png and /dev/null differ diff --git a/docs/supervisor-add-on-store.png b/docs/supervisor-add-on-store.png deleted file mode 100644 index 003ccca..0000000 Binary files a/docs/supervisor-add-on-store.png and /dev/null differ diff --git a/docs/supervisor-dashboard.png b/docs/supervisor-dashboard.png deleted file mode 100644 index 5922282..0000000 Binary files a/docs/supervisor-dashboard.png and /dev/null differ diff --git a/docs/supervisor-manage-repositories.png b/docs/supervisor-manage-repositories.png deleted file mode 100644 index 5f21411..0000000 Binary files a/docs/supervisor-manage-repositories.png and /dev/null differ