diff --git a/README.md b/README.md index 180f1f0..b773350 100644 --- a/README.md +++ b/README.md @@ -15,25 +15,25 @@ curl -fsSL https://codeberg.org/vegvisir/install/raw/branch/master/install.sh | # Arguments You can pass optional named arguments to this script for headless installation of Vegvisir. -## `--install` - Don't install, only configure Vegvisir +### `--install` - Don't install, only configure Vegvisir ```sh ./install.sh --install=n ``` Pass `--install=n` to prevent download and installation of the Vegvisir git submodule. Use this option if you're version controlling Vegvisir from your project repository. -## `--dir` - Installation directory +### `--dir` - Installation directory ```sh ./install.sh --dir="/path/to/project" ``` Pass a `--dir` argument with a value of a directory Vegvisir should consider its [`root_path`](https://vegvisir.vlw.se/docs/Reference/Env#root_path). -## `--overwrite` - Overwrite configuration files +### `--overwrite` - Overwrite configuration files ```sh ./install.sh --overwrite=y ``` Pass `--overwrite=y` to replace existing Vegvisir configuration files. -## `--example` - Generate example website +### `--example` - Generate example website ```sh ./install.sh --example=n ```