Skip to content

Commit d729ad5

Browse files
author
Bruno Sutic
committed
Update readme with screenshots
1 parent bf1b0bd commit d729ad5

File tree

3 files changed

+29
-1
lines changed

3 files changed

+29
-1
lines changed

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,25 @@
11
# Tmux online status
22

3-
Tmux plugin that displays online status of your workstation.
3+
Tmux plugin that enables displaying online status for your workstation.
4+
5+
Introduces a new `#{online_status}` format.
6+
7+
### Usage
8+
9+
Add `#{online_status}` format string to your existing `status-right` tmux
10+
option.
11+
12+
Here's the example:
13+
14+
# in .tmux.conf
15+
set -g status-right "Online: #{online_status} | %a %h-%d %H:%M "
16+
17+
The above will result in this:<br/>
18+
![online indicator](/screenshots/online_indicator.png)<br/>
19+
or this<br/>
20+
![offline indicator](/screenshots/offline_indicator.png)<br/>
21+
22+
The icon will of course change as you connect/disconnect from the internet.
423

524
### Installation with [Tmux Plugin Manager](https://github.com/bruno-/tpm) (recommended)
625

@@ -13,6 +32,8 @@ Add plugin to the list of TPM plugins in `.tmux.conf`:
1332

1433
Hit `prefix + I` to fetch the plugin and source it.
1534

35+
`#{online_status}` interpolation should now work.
36+
1637
### Manual Installation
1738

1839
Clone the repo:
@@ -28,12 +49,19 @@ Reload TMUX environment:
2849
# type this in terminal
2950
$ tmux source-file ~/.tmux.conf
3051

52+
`#{online_status}` interpolation should now work.
53+
3154
### Limitations
3255

3356
Online status icon most likely won't be instant. The duration depends on the
3457
`status-interval` Tmux option. So, it might take anywhere between 5 and 60
3558
seconds for online status icon to change.
3659

60+
Set `status-interval` to a low number to make this faster, example:
61+
62+
# in .tmux.conf
63+
set -g status-interval 5
64+
3765
### License
3866

3967
[MIT](LICENSE.md)

screenshots/offline_indicator.png

9.34 KB
Loading

screenshots/online_indicator.png

9.28 KB
Loading

0 commit comments

Comments
 (0)