From 7100e9a966e5b4a7672224f167e265052a22b6f8 Mon Sep 17 00:00:00 2001
From: Philippe Martin <phmartin@redhat.com>
Date: Mon, 22 Jan 2024 11:14:02 +0100
Subject: [PATCH] initial readme

---
 README.md | 28 ++++++++++++++++++++++++++--
 1 file changed, 26 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 87c44abde..3f5475f0f 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,29 @@
 # studio extension
 
-Run in development mode:
+## Installing a development version
 
-`yarn watch --extension-folder ~/git/projectatomic/packages/backend`
+You can install this extension from Podman Desktop UI > ⚙ Settings > Extensions > Install a new extension from OCI Image.
+
+The name of the image to use is `ghcr.io/projectatomic/studio-extension:latest`.
+
+You can get earlier tags for the image at https://github.com/projectatomic/studio-extension/pkgs/container/studio-extension.
+
+These images contain development versions of the extension. There is no stable release yet.
+
+## Running in development mode
+
+From the Podman Desktop sources folder:
+
+```
+$ yarn watch --extension-folder path-to-extension-sources-folder/packages/backend
+```
+
+## Providing a custom catalog
+
+The extension provides a default catalog, but you can build your own catalog by creating a file `$HOME/podman-desktop/ai-studio/catalog.json`.
+ 
+The catalog provides lists of categories, recipes, and models.
+
+Each recipe can belong to one or several categories. Each model can be used by one or several recipes.
+
+The format of the catalog is not stable nor versioned yet, you can see the current catalog's format [in the sources of the extension](https://github.com/projectatomic/studio-extension/blob/main/packages/backend/src/ai.json).