From 17a137e47c5205bd7fd6fa2fcecaadf96829fbe2 Mon Sep 17 00:00:00 2001
From: JMARyA <jmarya@hydrar.de>
Date: Sat, 28 Dec 2024 03:53:47 +0100
Subject: [PATCH] update README

---
 README.md | 20 +++++++++++++++-----
 1 file changed, 15 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 43259fe..d30a11c 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,17 @@
 # NavInstall
+navOS Installer
 
-## Features
-- Install different configs
-- Install with JSON file
-- Install with CLI
-- Install with GUI
+## Create install medium
+You can create a bootable install medium either with or without GUI:
+```sh
+navinstall create-iso [--without_gui]
+```
+
+## Install a system
+Install a system configuration:
+```sh
+navinstall install config.toml
+```
+
+`config.toml` is a system configuration describing how to install the system.
+Example configurations can be found [here](installs) or at `/usr/share/navinstall/installs/`.