diff --git a/README.md b/README.md index 3e4709a..637717b 100644 --- a/README.md +++ b/README.md @@ -2,38 +2,16 @@ 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). -Just click the "Use this template" button above and start adding your own apps! +## How to use: -### 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 as shown in the following demo: +1. Start by clicking the "Use this template" button located above. +2. Assign an ID and name to your app store within the `umbrel-app-store.yml` file. This file specifies two important attributes: + - `id` - Acts as a unique prefix for every app within your Community App Store. You must start your application's ID with your app store's ID. For instance, in this template, the app store ID is `sparkles`, and there's an app named `hello world`. Consequently, the app's ID should be: `sparkles-hello-world`. + - `name` - This is the name of the Community App Store displayed in the umbrelOS UI. +3. Change the name of the `sparkles-hello-world` folder to match your app's ID. The app ID is for you to decide. For example, if your app store ID is `whistles`, and your app is named My Video Downloader, you could set its app ID to `whistles-my-video-downloader`, and rename the folder accordingly. +4. Next, enter your app's listing details in the `whistles-my-video-downloader/umbrel-app.yml`. These are displayed in the umbrelOS UI. +5. Include the necessary Docker services in `whistles-my-video-downloader/docker-compose.yml`. +6. That's it! Your Community App Store, featuring your unique app, is now set up and ready to go. To use your Community App Store, you can add its GitHub url the umbrelOS user interface as shown in the following demo: https://user-images.githubusercontent.com/10330103/197889452-e5cd7e96-3233-4a09-b475-94b754adc7a3.mp4 - - -Alternatively, you can use the Umbrel CLI as described below. - -To add an app store: -``` -sudo ~/umbrel/scripts/repo add https://github.com/getumbrel/umbrel-community-app-store.git - -sudo ~/umbrel/scripts/repo update -``` - -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 -```