diff --git a/README_FULL.md b/README_FULL.md index f69601c..af496f2 100644 --- a/README_FULL.md +++ b/README_FULL.md @@ -3,7 +3,7 @@ This guide explains **all features** of Bahmcloud Store (BCS) for Home Assistant. It is written for users and admins who want a complete, practical reference. -> TL;DR: BCS lets you install & manage custom integrations from **GitHub/GitLab/Gitea** and your own sources, with backups, restore, and version pinning. +> BCS lets you install & manage custom integrations from **GitHub/GitLab/Gitea** and your own sources, with backups, restore, and version pinning. --- @@ -29,16 +29,8 @@ It is written for users and admins who want a complete, practical reference. ## Concepts -- **Index (`store.yaml`)**: your curated list of repositories. Example: - ```yaml - refresh_seconds: 300 - repos: - - name: Easy Proxmox - url: https://git.bahmcloud.de/bahmcloud/easy_proxmox - category: Infrastructure - ``` - **Sources**: - - **BCS Official** → entries from your index (`store.yaml`) + - **BCS Official** → entries from index (`store.yaml`) made and added from Bahmcloud - **HACS** → official HACS integrations list (toggleable) - **Custom** → manual entries you add locally - **Install location**: `/config/custom_components/` @@ -49,7 +41,7 @@ It is written for users and admins who want a complete, practical reference. ## Sources (BCS / HACS / Custom) Each repository card shows a **source badge**: -- **BCS Official** – from your index +- **BCS Official** – from Bahmcloud index - **HACS** – from HACS official list (enable with the toggle) - **Custom** – added by you @@ -61,9 +53,10 @@ You can **filter by source** with the **Source** dropdown (All / BCS Official / Top bar: - **Search** (name/description) -- **Category** filter -- **Source** filter (BCS/HACS/Custom) -- **Sort** (name, updated, etc.) +- **Source** filter (All/BCS Official/HACS/Custom) +- **Category** filter (actually only Integrations are supported) +- **State-Filter** filter (All/Installed/Not installed/Update available/Custom repos) +- **Sort** (name (A-Z)/Updates first/Installed first) - **HACS official** toggle (on/off) Repository card: @@ -89,7 +82,7 @@ Descriptions and latest versions are filled progressively by a background proces 1. Open a repository. 2. Optionally select **Install version** (default: **Latest**). 3. Click **Install** and wait for confirmation. -4. Follow the **Restart required** prompt. +4. Follow the **Restart required** prompt. (or use restart toggle in HomeAssistant Settings) **What happens internally** - BCS downloads the repository ZIP for the selected version (release/tag/branch). @@ -135,9 +128,9 @@ Before an update/install over existing files, BCS creates a backup: ``` **Restore**: -1. Open the repository. +1. Open the repository in store. 2. Select **Restore…**. -3. Pick one of the **last backups** (up to retention limit). +3. Pick one of the **last backups** (up to retention limit). (Version details are showed in ()) 4. Confirm – BCS restores files and reconciles installed version to the restored ref. 5. Restart Home Assistant if prompted. @@ -147,16 +140,25 @@ If the old backup lacks metadata, BCS best‑effort derives the installed versio ## Custom Repositories -You can add any public repository (GitHub/GitLab/Gitea). BCS will attempt to detect: +You can add any public repository (GitHub/GitLab/Gitea/Any other Git Hoster). BCS will attempt to detect: - provider & default branch - latest version (release/tag/atom) - repo metadata (prefer `bcs.yaml`, fallback `hacs.json/hacs.yaml`) - readme (common filenames) -**To add a custom repo** (typical flows): -- From the Store UI (if available), or -- via API (see developer docs), or -- by editing your local custom repo storage (advanced). +**Add an custom repository**(typical flows): +- From the Store UI + 1. If you start up Bahmcloud Store, you are on tab "Store" + 2. Go to tab "Manage" + 3. Add Repository URL (Example: ``https://git.bahmcloud.de/bahmcloud/bahmcloud_store``) and (optional) Name you want to show up (will be grabbed from GIT Repository) + 4. Repository show up in Custom Repositories-list and in "Store" Tab, if available + +**Remove an custom repository**(typical flows): +- From the Store UI + 1. If you start up Bahmcloud Store, you are on tab "Store" + 2. Go to tab "Manage" + 3. Your repository you want to remove (if its custom) show up in the list + 4. Press "Remove" Button to delete from Store (Attention: If you Remove installed Repository, you won´t be able to Uninstall from Store, you have to remove by your own (Delete Folder from ```config/custom_components/*```)) Custom repos get the **Custom** badge and can be filtered via **Source**. @@ -167,7 +169,7 @@ Custom repos get the **Custom** badge and can be filtered via **Source**. Enable the **HACS official** toggle to include official HACS integrations. - BCS downloads the HACS integration list and maps **human‑readable names/descriptions** from HACS metadata. -- HACS entries are **not** part of your `store.yaml` (avoid duplicate entries). +- HACS entries are **not** part of your BCS-Official Repositories (avoid duplicate entries). With many HACS repos, metadata loads in the background; names/descriptions appear progressively and are cached. @@ -190,8 +192,6 @@ BCS exposes update entities for installed repos: - **Persistent cache**: survives HA restarts; speeds up subsequent runs - **Refresh**: immediately rechecks installed repos and key metadata -If you enable HACS, keep your `store.yaml` light and curated. - --- ## Restart Required @@ -204,6 +204,7 @@ After install, update, or restore, BCS raises a **Restart required** item in Hom - **New release but no update**: Open the repo detail once; ensure it’s a **release/tag** (commits alone don’t change the ref). - **Descriptions/Latest missing**: Wait for background enrichment or open the repo detail (forces enrichment). Cached afterwards. +(You also can Install new version by selecting in Version tab) - **Slow startup**: BCS schedules heavy work after HA started. Keep indexes reasonable. ---