From aaead9a19cfa3f7ef2fb7f37578b373df5780dab Mon Sep 17 00:00:00 2001
From: Sheogorath <sheogorath@shivering-isles.com>
Date: Sat, 10 Dec 2022 02:51:46 +0000
Subject: [PATCH] docs(kOS): Add basic usage instructions

---
 images/kos/README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/images/kos/README.md b/images/kos/README.md
index 741eb9f05..0f3df2cf8 100644
--- a/images/kos/README.md
+++ b/images/kos/README.md
@@ -3,6 +3,20 @@ kOS
 
 kOS (read 'chaos') is a simple OS based on CoreOS with the applied modifications for this repositories needs. It'll provide an easy way to reliably update the base OS of the cluster.
 
+Usage
+---
+
+To install kOS, it's currently mandatory to install a regular CoreOS machine first. Then run the following command:
+
+```shell
+sudo rpm-ostree rebase --experimental ostree-unverified-registry:quay.io/shivering-isles/kos:stable
+sudo systemctl reboot
+```
+
+This will download the latest images version and rebase the existing system to this customised image.
+
+For updates, just run the regular `rpm-ostree upgrade`.
+
 Concept
 ---
 
-- 
GitLab