Add documentation to template

.gitignore

@@ -1,2 +1 @@
 .DS_Store
-*.pem

README.md

@@ -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
+```

sparkles-hello-world/docker-compose.yml

@@ -4,7 +4,8 @@ services:
 
   app_proxy:
     environment:
-      APP_HOST: hello_world_server_1
+      # The format here is: <app-id>_<docker-service-name>_1
+      APP_HOST: sparkles-hello-world_server_1
       APP_PORT: 3000
     
   server:

sparkles-hello-world/umbrel-app.yml

@@ -1,5 +1,5 @@
 manifestVersion: 1
-id: hello-world
+id: sparkles-hello-world
 name: Hello World
 tagline: Replace this tagline with your app's tagline
 icon: https://svgur.com/i/mvA.svg

umbrel-app-store.yml

@@ -0,0 +1,2 @@
+id: "sparkles" # Choose the ID for your app store. This should contain only alphabets ("a to z") and dashes ("-").
+name: "Sparkles" # Choose the name of your app store. It will show up in the UI as "<name> App Store".

umbrel-repo.yml

@@ -1,2 +0,0 @@
-id: "hello-world" # Choose the ID for your app store. This should contain only alphabets ("a to z") and dashes ("-").
-name: "Hello World" # Choose the name of your app store. It will show up in the UI as "<name> App Store".