Merge pull request #5 from Eskander/dev

Add documentation

README.md

@@ -1 +1,26 @@
-# Home Assistant Add-on: ArchiSteamFarm
+# Home Assistant Add-on: ArchiSteamFarm
+
+![Maintenance](https://img.shields.io/maintenance/yes/2024.svg)
+![Github Actions](https://github.com/Eskander/ha-addon-archisteamfarm/actions/workflows/builder.yaml/badge.svg?branch=main)
+![Supports amd64 Architecture](https://img.shields.io/badge/amd64-yes-green.svg)
+![Supports aarch64 Architecture](https://img.shields.io/badge/aarch64-yes-green.svg)
+![Supports armv7 Architecture](https://img.shields.io/badge/armv7-yes-green.svg)
+![ingress-badge](https://img.shields.io/badge/-ingress-blueviolet.svg?logo=cliqz&logoColor=white)
+
+## About
+
+[ArchiSteamFarm](https://github.com/JustArchiNET/ArchiSteamFarm/) is a C# application with primary purpose of farming Steam cards from multiple accounts simultaneously.
+
+This add-on installs ArchiSteamFarm on [Home Assistant](https://www.home-assistant.io/addons/) to be used from the sidebar (*ingress*), or as a standalone service (via *host:port*).
+
+![screenshot](screenshot.png)
+
+## Documentation
+
+Add-on documentation is available [here](/archisteamfarm/DOCS.md).
+
+For information about ASF configuration options, see project [documentation](https://github.com/JustArchiNET/ArchiSteamFarm/wiki).
+
+## Install
+
+[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2FEskander%2Fha-addon-archisteamfarm)

archisteamfarm/CHANGELOG.md

@@ -1,4 +1,6 @@
 ## 1.2
+- Add documentation
+## 1.1
 - Update ASF to 5.5.0.11
 ## 1.0
 - Initial release

archisteamfarm/DOCS.md

@@ -0,0 +1,14 @@
+# Home Assistant Add-on: ArchiSteamFarm
+
+## How to use
+Set "*Show in sidebar*" setting (found on **Info** tab) to "*on*" to add ArchiSteamFarm to Home Assistant sidebar.
+
+You can also access ASF-ui on `homeassistant.local:port` by defining a **port** on **Configuration** tab.
+
+## Configuration
+Configuration folder is found on `/addon_configs/bccc8195_archisteamfarm`
+
+See ASF [documentation](https://github.com/JustArchiNET/ArchiSteamFarm/wiki) for information about configuration options.
+
+## Support
+For bug reports, [open an issue on GitHub](https://github.com/Eskander/ha-addon-archisteamfarm/issues).

archisteamfarm/README.md

@@ -1 +1,14 @@
-# Home Assistant Add-on: ArchiSteamFarm
+# Home Assistant Add-on: ArchiSteamFarm
+
+![Maintenance](https://img.shields.io/maintenance/yes/2024.svg)
+![Github Actions](https://github.com/Eskander/ha-addon-archisteamfarm/actions/workflows/builder.yaml/badge.svg?branch=main)
+![Supports amd64 Architecture](https://img.shields.io/badge/amd64-yes-green.svg)
+![Supports aarch64 Architecture](https://img.shields.io/badge/aarch64-yes-green.svg)
+![Supports armv7 Architecture](https://img.shields.io/badge/armv7-yes-green.svg)
+![ingress-badge](https://img.shields.io/badge/-ingress-blueviolet.svg?logo=cliqz&logoColor=white)
+
+## About
+
+[ArchiSteamFarm](https://github.com/JustArchiNET/ArchiSteamFarm/) is a C# application with primary purpose of farming Steam cards from multiple accounts simultaneously.
+
+For information about ASF configuration options, see project [documentation](https://github.com/JustArchiNET/ArchiSteamFarm/wiki).

archisteamfarm/config.yaml

@@ -1,5 +1,5 @@
 name: ArchiSteamFarm
-version: "1.1"
+version: "1.2"
 slug: archisteamfarm
 description: C# application with primary purpose of farming Steam cards from multiple accounts simultaneously
 url: https://github.com/Eskander/ha-addon-archisteamfarm
@@ -15,5 +15,7 @@ ingress_port: 1242
 panel_icon: mdi:steam
 ports:
   1242/tcp: null
+ports_description:
+  1242/tcp: Web interface
 map:
   - addon_config:rw