Add documentation to template

This commit is contained in:
Steven Briscoe
2022-09-29 15:34:26 +01:00
parent 91127b43c5
commit 43910520f5
6 changed files with 34 additions and 8 deletions

View File

@@ -1,3 +1,29 @@
### Todo
## Umbrel Community App Store Template
Add step-by-step guide on using this template repository to start your own community app store.
This repository is a template to create an Umbrel Community App Store. These additional app stores allow developers to distribute applications without submitting to the [Official Umbrel App Store](https://github.com/getumbrel/umbrel-apps).
### Technical Details
The `umbrel-app-store.yml` file defines two important properties:
- `id` - This is used as a prefix for all apps within the community app store. You **MUST** prefix your application id with your app store ID. For example, this template defines `sparkles` as a community app store ID and we have a `hello world` app. The app ID therefore should be: `sparkles-hello-world`
- `name` - This name appears within the Umbrel user interface when users explore apps within these community app stores.
### Testing
To test your community app store, you can add this repository through the Umbrel user interface, or using Umbrel's CLI.
To add an app store:
```
sudo ~/umbrel/scripts/repo add https://github.com/getumbrel/umbrel-community-app-store.git
```
To install an app from the app store
```
sudo ~/umbrel/scripts/app install sparkles-hello-world
```
To remove an app store:
```
sudo ~/umbrel/scripts/repo remove https://github.com/getumbrel/umbrel-community-app-store.git
```