Use sub as the default command in the README

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
2026-10-22 10:18:34 +02:00
co-authored by Claude Sonnet 5.5
parent e0f4ac823b
commit 651ab10f51
+9 -6
View File
@@ -35,18 +35,21 @@ the questions you actually have:
curl -fsSL https://git.simon-franken.de/simonfranken/submarine/raw/branch/main/install.sh | sh curl -fsSL https://git.simon-franken.de/simonfranken/submarine/raw/branch/main/install.sh | sh
``` ```
Installs `submarine` and the alias `sub` (linux/macOS, amd64/arm64) to Installs `sub` and `submarine` (linux/macOS, amd64/arm64) to `~/.local/bin`.
`~/.local/bin`. Update later with `submarine update`. Both names start the same program; the examples below use the shorter `sub`.
Update later with `sub update`.
## Try it ## Try it
```sh ```sh
submarine # the repository in the current directory sub # the repository in the current directory
submarine ~/code/project # any directory inside a repository sub ~/code/project # any directory inside a repository
submarine --no-fetch # skip the background fetch sub --no-fetch # skip the background fetch
submarine --mock # built-in sample data, no repository needed sub --mock # built-in sample data, no repository needed
``` ```
`submarine` works everywhere `sub` does, e.g. `submarine --mock`.
## Examples ## Examples
### Find what needs attention ### Find what needs attention