README_DEVELOPER.md aktualisiert
This commit is contained in:
@@ -5,9 +5,9 @@ For contributors and maintainers.
|
|||||||
## Architecture
|
## Architecture
|
||||||
|
|
||||||
Repositories:
|
Repositories:
|
||||||
1) Installer Add-on (HAOS/Supervised)
|
1) Installer Add-on (HAOS/Supervised) ```https://git.bahmcloud.de/bahmcloud/addons```
|
||||||
2) Core Integration
|
2) Core Integration ```https://git.bahmcloud.de/bahmcloud/bahmcloud_store```
|
||||||
3) Store Index (`store.yaml`)
|
3) Store Index (`store.yaml`) ```https://git.bahmcloud.de/bahmcloud/ha_store```
|
||||||
|
|
||||||
### Integration Layout
|
### Integration Layout
|
||||||
|
|
||||||
@@ -41,6 +41,7 @@ custom_components/bahmcloud_store/
|
|||||||
- GitHub: API/releases/tags/atom + raw readme
|
- GitHub: API/releases/tags/atom + raw readme
|
||||||
- GitLab: API releases/tags + raw readme
|
- GitLab: API releases/tags + raw readme
|
||||||
- Gitea: API releases/tags + raw readme
|
- Gitea: API releases/tags + raw readme
|
||||||
|
- Custom: API or HTTPS Request to your Git Provider
|
||||||
|
|
||||||
## Metadata
|
## Metadata
|
||||||
|
|
||||||
@@ -76,18 +77,18 @@ Base: /api/bcs
|
|||||||
|
|
||||||
## Contributing to **BCS Official**
|
## Contributing to **BCS Official**
|
||||||
|
|
||||||
1) Fork index repo (with `store.yaml`)
|
1) Add pull request to `https://git.bahmcloud.de/bahmcloud/ha_store` (with your integration added to) `store.yaml`)
|
||||||
2) Add entry:
|
2) Add entry:
|
||||||
```yaml
|
```yaml
|
||||||
- name: Your Integration Name
|
- name: Your Integration Name
|
||||||
url: https://github.com/your-org/your-repo
|
url: https://your-git-hoster.com/your-org/your-repo
|
||||||
category: Category
|
category: Category (actually only "Integrations" are supported)
|
||||||
```
|
```
|
||||||
3) (Recommended) Add `bcs.yaml` to your repo:
|
3) (Recommended) Add `bcs.yaml` to your repo:
|
||||||
```yaml
|
```yaml
|
||||||
name: Your Integration Name
|
name: Your Integration Name
|
||||||
description: One-liner for the store
|
description: One-liner for the store (optional, store information are also catched from git repository)
|
||||||
category: Sensors
|
category: Integrations (actually only supported)
|
||||||
author: Your Name
|
author: Your Name
|
||||||
maintainer: Your Handle
|
maintainer: Your Handle
|
||||||
```
|
```
|
||||||
@@ -100,3 +101,15 @@ maintainer: Your Handle
|
|||||||
- Respect provider rate limits
|
- Respect provider rate limits
|
||||||
- Clean logging around refresh/install/update/restore
|
- Clean logging around refresh/install/update/restore
|
||||||
- Keep UI responsive; throttle updates
|
- Keep UI responsive; throttle updates
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Planed Features
|
||||||
|
|
||||||
|
- Add Downloads and install for category "Dashboard"
|
||||||
|
- Add Downloads and install for category "Template"
|
||||||
|
- Add Downloads and install for category "Theme"
|
||||||
|
- Add Downloads and install for category "Blueprint"
|
||||||
|
-
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user