Added documentation

This commit is contained in:
Eric Renfro 2018-12-19 13:48:10 -05:00
parent 9b5b85841d
commit bb88ae6d8a
Signed by: psi-jack
GPG key ID: 14977F3A50D9A5BF

View file

@ -0,0 +1,50 @@
# Tmux Host Status
Plugin that shows what host you're accessing, and what username you're accessinging it with.
### Usage
Just add `#{username}` and/or `#{hostname}` to your left or right status bar/
```tmux.conf
set -g status-right '#{username} #{hostname} | %a %Y-%m-%d %H:%M'
```
### Installation with Tmux Plugin Manager (recommended)
Add the plugin to the list of TPM plugins:
```tmux.conf
set -g @plugin 'https://git.linux-help.org/psi-jack/tmux-host'
```
Press prefix+I to install it.
### Manual Installation
Clone the repo:
```bash
$ git clone https://git.linux-help.org/psi-jack/tmux-host ~/clone/path
```
Add this line to your .tmux.conf:
```tmux.conf
run-shell ~/clone/path/host.tmux
```
Reload TMUX environment with:
```bash
tmux source-file ~/.tmux.conf
```
### Configurations
FIXME
### License
GPLv3