From 0e9f8c84a7f8c96b63837361c6215eef8123034a Mon Sep 17 00:00:00 2001 From: Matt Hunter Date: Sun, 22 Feb 2026 03:25:07 -0500 Subject: Remove shell-specific options from README examples The --bash/--zsh/--fish options were converted to no-op command line flags a while back, since their behavior in git-sonar is identical. They are merely still recognized for compatibility with git-radar. This being the case, don't recommend their use in git-sonar's README file. Signed-off-by: Matt Hunter --- README.md | 28 +++++++--------------------- 1 file changed, 7 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index cf6a606..c1155d3 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ ways depending on your shell. Add to your `.bashrc` ```bash -export PS1="$PS1\$(git-sonar --bash) " +export PS1="$PS1\$(git-sonar) " ``` [(note: the `\` escaping the `$` is important)](#ensuring-prompt-execution) @@ -56,7 +56,7 @@ export PS1="$PS1\$(git-sonar --bash) " Add to your `.zshrc` ```zsh -export PROMPT="$PROMPT\$(git-sonar --zsh) " +export PROMPT="$PROMPT\$(git-sonar) " ``` [(note: the `\` escaping the `$` is important)](#ensuring-prompt-execution) @@ -67,7 +67,7 @@ Add to your `config.fish` function fish_prompt set_color $fish_color_cwd echo -n (prompt_pwd) - echo -n (git-sonar --fish) + echo -n (git-sonar) set_color normal echo -n ' > ' end @@ -164,20 +164,6 @@ used git-sonar will run `git fetch` asynchronously every 5 minutes. This will only occur when the prompt is rendered and it will only occur on the repo you are currently in. -To use this feature, when setting your prompt, call git-sonar with `--fetch`: - -**Bash** -```bash -export PS1="$PS1\$(git-sonar --bash --fetch)" -``` -[(note: the `\` escaping the `$` is important)](#ensuring-prompt-execution) - -**Zsh** -```zsh -export PROMPT="$PROMPT\$(git-sonar --zsh --fetch) " -``` -[(note: the `\` escaping the `$` is important)](#ensuring-prompt-execution) - You may also choose to fetch at a customized interval of time. To do so, add this to your .bashrc, .zshrc: @@ -254,14 +240,14 @@ to escape the execution of the function. There are two ways to do this: **1. Use `$'` to render raw characters** ```bash -export PROMPT=$'$(git-sonar --zsh)' -export PS1=$'$(git-sonar --bash)' +export PROMPT=$'$(git-sonar)' +export PS1=$'$(git-sonar)' ``` **2. Use `\` to escape execution of the subshell** ```bash -export PROMPT="\$(git-sonar --zsh)" -export PS1="\$(git-sonar --bash)" +export PROMPT="\$(git-sonar)" +export PS1="\$(git-sonar)" ``` ### Configuring colours -- cgit v1.2.3