diff --git a/README.md b/README.md index bb8bd44..180f1f0 100644 --- a/README.md +++ b/README.md @@ -15,13 +15,19 @@ 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` - Installation directory +## `--install` - Don't install, only configure Vegvisir ```sh -./install.sh --install="/path/to/project" +./install.sh --install=n ``` -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). +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. -## `--override` - Overwrite configuration files +## `--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 ```sh ./install.sh --overwrite=y ```