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/`.