doc: add args doc to README

README.md

@@ -1,13 +1,34 @@
 # Vegvisir installer
-This script will automatically install and configure Vegvisir from in a fresh git repository.
+Run this script from a git repository to automatically install and configure Vegvisir as a git submodule to your project.
 
-## Important
+> [!IMPORTANT]
-The script will only run on Linux environments with `coreutils` installed (for now).
+> The script will only run in environments with Bash and `coreutils` installed (for now).
 
 # Get started
-1. Create a repository for your website
+1. Create a git repository for your project.
-2. Run this command from the root directory of your local repository
+2. Run this command from the root directory of your local repository.
 
 ```sh
-curl -fsSL https://href.vlw.se/vegvisir/install | bash
+curl -fsSL https://codeberg.org/vegvisir/install/raw/branch/master/install.sh | bash
 ```
+
+# Arguments
+You can pass optional named arguments to this script for headless installation of Vegvisir.
+
+## `--install` - Installation directory
+```sh
+./install.sh --install="/path/to/project"
+```
+Pass an `--install` argument with a value of a directory Vegvisir should consider its [`root_path`](https://vegvisir.vlw.se/docs/Reference/Env#root_path).
+
+## `--override` - Overwrite configuration files
+```sh
+./install.sh --overwrite=y
+```
+Pass `--overwrite=y` to replace existing Vegvisir configuration files.
+
+## `--example` - Generate example website
+```sh
+./install.sh --example=n
+```
+Pass `--overwrite=n` to disable generation of an example website after installation.