Skip to content

Commit

Permalink
Add flavor and links to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgebucaran committed Jul 5, 2022
1 parent 383cdd9 commit b01e0be
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ fisher install jorgebucaran/hydro

## Features

One prompt symbol to rule them all. [Change it](#configuration).
One prompt symbol to rule them all. [Change it](#configuration)?

<pre>
<b>~</b> ❱ ⎢
</pre>

Show Git branch name and status—prompt repaints asynchronously! ✨
Display Git branch name and status—prompt repaints asynchronously! ✨

<pre>
~/p/<b>hydro</b> main ❱ touch Solution
Expand All @@ -29,39 +29,39 @@ Show Git branch name and status—prompt repaints asynchronously! ✨

> `` indicates that there are staged, unstaged or untracked files.
Show how many commits you're ahead and/or behind of your upstream—prompt repaints asynchronously!
Display how many commits ahead and/or behind you are of your upstream—prompt repaints asynchronously!

<pre>
~/p/<b>hydro</b> main• ↓2 ❱ git commit -am Hotfix
~/p/<b>hydro</b> main ↑1 ↓2 ❱ git pull --rebase && git push
~/p/<b>hydro</b> main ❱ ⎢
</pre>

Show `$CMD_DURATION` if > `1` second.
Display [`$CMD_DURATION`](https://fishshell.com/docs/current/language.html?highlight=cmd_duration#envvar-CMD_DURATION) when > `1` second.

<pre>
~/p/<b>hydro</b> main ❱ git push --quiet
~/p/<b>hydro</b> main 1.1s ❱ ⎢
</pre>

Show the last `$pipestatus`.
Display the last non-zero [exit status](https://fishshell.com/docs/current/tutorial.html#exit-status) (or statuses) using [`$pipestatus`](https://fishshell.com/docs/current/language.html?highlight=cmd_duration#envvar-pipestatus).

<pre>
~/p/<b>hydro</b> main ❱ false
~/p/<b>hydro</b> main ❱ [<b>1</b>]
~/p/<b>hydro</b> main | <b>1</b> ❱ ⎢
~/p/<b>hydro</b> main ❱ true | false | false
~/p/<b>hydro</b> main | <b>0</b> <b>1</b> <b>1</b> ❱ ⎢
</pre>

Truncate `$PWD` segments except for the basename and root of Git repos.
Truncate [`$PWD`](https://fishshell.com/docs/current/language.html?highlight=cmd_duration#envvar-PWD) segments except for the basename and root of Git repos.

<pre>
<b>~</b> ❱ projects/hydro/
~/p/<b>hydro</b> ❱ functions/share/
~/p/hydro/f/<b>share</b> ❱ ⎢
</pre>

Show current bindings mode.
Display the current bindings mode.

<pre>
<i>I</i> <b>~</b> ❱ <kbd>Esc</kbd>
Expand Down Expand Up @@ -119,7 +119,7 @@ Modify variables using `set --universal` from the command line or `set --global`
| Variable | Type | Description | Default |
| ---------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------ | ------- |
| `fish_prompt_pwd_dir_length` | numeric | The number of characters to display when path shortening. Set it to `0` to display only the topmost (current) directory. | `1` |
| `hydro_ignored_git_paths` | strings | Space separated list of paths where no git info should be displayed | `""` |
| `hydro_ignored_git_paths` | strings | Space separated list of paths where no git info should be displayed. | `""` |

## License

Expand Down

0 comments on commit b01e0be

Please sign in to comment.