From f745f8ec1e1060000054fe7046c3d4a8177b5d99 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Bachmann?= Date: Mon, 19 Jan 2026 07:39:35 +0000 Subject: [PATCH] Add readme --- README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 48 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d791911..3ef8526 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,49 @@ -# bahmcloud_store +# Bahmcloud Store (BCS) for Home Assistant -Bahmcloud Store for installing costum_components to Homeassistant \ No newline at end of file +Bahmcloud Store (BCS) is a provider-neutral store for Home Assistant custom integrations. +It allows you to browse, install, update, downgrade, uninstall and restore integrations +directly from the Home Assistant UI. + +This README is intended for **end users**. + +--- + +## Installation + +### Option A: Home Assistant OS / Supervised (Add-on – recommended) + +1. Open **Settings → Add-ons → Add-on Store** +2. Add the Bahmcloud Add-on repository +3. Install **Bahmcloud Store Installer** +4. Start the add-on +5. Restart Home Assistant + +Installed to: +/config/custom_components/bahmcloud_store + +--- + +### Option B: Manual Installation (Container / Core) + +1. Download the latest release +2. Copy `custom_components/bahmcloud_store` to: + /config/custom_components/bahmcloud_store +3. Restart Home Assistant + +--- + +## Repository Sources + +- **BCS Official** +- **HACS** +- **Custom** + +--- + +## Documentation + +Developer documentation: +https://git.bahmcloud.de/bahmcloud/bahmcloud_store/src/branch/main/README_DEVELOPER.md + +Full technical documentation: +https://git.bahmcloud.de/bahmcloud/bahmcloud_store/src/branch/main/README_FULL.md