Update README.md with branch brackets meanings

jimeh · Jan 8, 2019 · c1f47ac · c1f47ac
1 parent f2bffbe
commit c1f47ac
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -48,6 +48,16 @@ The initial implementation of the timeout feature is on [this commit](https://gi
 
 > `(s)` is a reminder that the top stash was made on the current branch, or the current commit.
 
+We also have some indicators for the current branch:
+
+> `[branch_name]` means you are on a branch with an upstream
+
+> `(branch_name)` means you are on a branch without an upstream
+
+> `{branch_name\mode}` means you are in the middle of a merge, rebase, cherry-pick, revert or bisect
+
+> `<commit_id>` means you are detached on the given commit
+
 The symbols (or "markers") can be changed by editing the `prompt.sh` file directly (and reloading it of course).  The numbers or the markers can be omitted by removing the `_count` or `_mark` variables from the `PS1` prompt below.