ae284f06d56a3a0fb575647b6142721d9c6e41d1

Author
TheEdgeOfRage <git@theedgeofrage.com>
Committer
TheEdgeOfRage <git@theedgeofrage.com>
Date

Message

Improve readme

Diff

 1diff --git a/README.md b/README.md
 2index bc029be651f87d85fd5d055cac0e54eb89d555d4..c39dfc256430f6f74fc33ce1afc9e131267f2fb2 100644
 3--- a/README.md
 4+++ b/README.md
 5@@ -11,7 +11,11 @@ directory in your oh-my-zsh installation and set `ZSH_THEME="boban/boban"` in yo
 6 
 7 You also need to have a [Nerdfont](https://www.nerdfonts.com/) to have all the symbols show up properly.
 8 
 9-## Configuration
10+## Usage
11+
12+The prompt segments will hide themselves when there is no relevant env vars set for them, or you are not in a
13+directory that has a git repo or terraform workspace. With nothing set, only the user@host and working directory
14+segments will show up.
15 
16 You can set the `DEFAULT_USER` env var to your username in your zshrc before loading this theme to stop showing the
17 first prompt segment when you are on your main user. It will always show when you are ssh-ed into the host where the