Add blueprint support and refresh documentation
This commit is contained in:
74
README.md
74
README.md
@@ -1,50 +1,86 @@
|
||||
# Bahmcloud Store (BCS) for Home Assistant
|
||||
|
||||
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.
|
||||
Bahmcloud Store (BCS) is a provider-neutral store for Home Assistant content hosted on git platforms.
|
||||
It currently supports installing and managing:
|
||||
|
||||
This README is intended for **end users**.
|
||||
- Integrations
|
||||
- Blueprints
|
||||
|
||||
Supported providers today:
|
||||
|
||||
- GitHub
|
||||
- GitLab
|
||||
- Gitea / Forgejo-style hosts
|
||||
- Custom repositories added by URL when the host behaves compatibly
|
||||
|
||||
This README is for end users.
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
|
||||
- Browse repositories from the official BCS index, HACS integration source, and custom repository URLs
|
||||
- Install, update, downgrade, and uninstall integrations directly from Home Assistant
|
||||
- Install blueprint repositories directly into the Home Assistant blueprints folder
|
||||
- Read repository README files inside the store UI
|
||||
- View release notes for provider releases
|
||||
- Pin repositories so important items stay easy to find
|
||||
- Use native Home Assistant update entities for installed integrations
|
||||
- Create and restore backups for integration installs and updates
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
### Option A: Home Assistant OS / Supervised (Add-on – recommended)
|
||||
### Option A: Home Assistant OS / Supervised
|
||||
|
||||
1. Open **Settings → Add-ons → Add-on Store**
|
||||
2. Add the Bahmcloud Add-on repository
|
||||
1. Open **Settings -> Add-ons -> Add-on Store**
|
||||
2. Add the Bahmcloud add-on repository:
|
||||
`https://git.bahmcloud.de/bahmcloud/addons`
|
||||
3. Install **Bahmcloud Store Installer**
|
||||
4. Start the add-on
|
||||
5. Restart Home Assistant
|
||||
|
||||
Installed to:
|
||||
/config/custom_components/bahmcloud_store
|
||||
`/config/custom_components/bahmcloud_store`
|
||||
|
||||
---
|
||||
|
||||
### Option B: Manual Installation (Container / Core)
|
||||
### Option B: Manual Installation
|
||||
|
||||
1. Download the latest release
|
||||
2. Copy `custom_components/bahmcloud_store` to:
|
||||
/config/custom_components/bahmcloud_store
|
||||
`/config/custom_components/bahmcloud_store`
|
||||
3. Restart Home Assistant
|
||||
|
||||
---
|
||||
|
||||
## Repository Sources
|
||||
|
||||
- **BCS Official**
|
||||
- **HACS**
|
||||
- **Custom**
|
||||
- **BCS Official**: repositories from the Bahmcloud store index
|
||||
- **HACS**: optional official HACS integration source
|
||||
- **Custom**: repositories you add manually by URL
|
||||
|
||||
---
|
||||
|
||||
## Current Content Support
|
||||
|
||||
### Integrations
|
||||
|
||||
- Expected repository content: `custom_components/<domain>/...`
|
||||
- Install target: `/config/custom_components/<domain>`
|
||||
- Supports install, update, uninstall, backup, restore, version selection, and update entities
|
||||
- Restart required after install, update, uninstall, or restore
|
||||
|
||||
### Blueprints
|
||||
|
||||
- Expected repository content: `blueprints/...`
|
||||
- Install target: `/config/blueprints/...`
|
||||
- Supports install and uninstall through the store
|
||||
- No restart is normally required for blueprint deployment
|
||||
|
||||
---
|
||||
|
||||
## Documentation
|
||||
|
||||
Developer documentation:
|
||||
https://git.bahmcloud.de/bahmcloud/bahmcloud_store/src/branch/main/README_DEVELOPER.md
|
||||
- Developer documentation: `README_DEVELOPER.md`
|
||||
- Full user guide: `README_FULL.md`
|
||||
|
||||
Full technical documentation:
|
||||
https://git.bahmcloud.de/bahmcloud/bahmcloud_store/src/branch/main/README_FULL.md
|
||||
|
||||
Reference in New Issue
Block a user