Skip to content

Commit 5d76676

Browse files
author
Bruno Sutic
committed
Update the readme
1 parent 85fa578 commit 5d76676

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,22 +15,28 @@ This plugin is useful if:
1515
Add `#{online_status}` format string to your existing `status-right` tmux
1616
option.
1717

18-
Here's the example:
18+
Here's the example in `.tmux.conf`:
1919

20-
# in .tmux.conf
2120
set -g status-right "Online: #{online_status} | %a %h-%d %H:%M "
2221

23-
The above will result in this:<br/>
22+
**OS X**<br/>
23+
On OS X the above will look like this when online<br/>
2424
![online indicator](/screenshots/online_indicator.png)<br/>
25-
or this<br/>
25+
or this when offline<br/>
2626
![offline indicator](/screenshots/offline_indicator.png)<br/>
2727

28-
On linux the emoji is not displayed, instead it will look like this:<br/>
28+
**Linux**<br/>
29+
Online status on Linux<br/>
2930
![online indicator](/screenshots/online_indicator_linux.png)<br/>
30-
or this<br/>
31+
offline status<br/>
3132
![offline indicator](/screenshots/offline_indicator_linux.png)<br/>
3233

33-
The icon will of course change as you connect/disconnect from the internet.
34+
#### Configure icons
35+
If the icons don't display well on your machine you can change them in
36+
`.tmux.conf`:
37+
38+
set -g @online_icon "ok"
39+
set -g @offline_icon "offline!"
3440

3541
### Installation with [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (recommended)
3642

0 commit comments

Comments
 (0)