installation instructions
This commit is contained in:
parent
3a882a9fdf
commit
12e1bbde10
1 changed files with 21 additions and 4 deletions
25
README.md
25
README.md
|
@ -1,10 +1,27 @@
|
|||
# tmux-watcher-tmux
|
||||
# aw-watcher-tmux - An activity watcher for tmux
|
||||
|
||||
A [activity watcher](https://activitywatch.net) for tmux.
|
||||
A tmux plugin that allows [activity watcher](https://activitywatch.net) to monitor activity in sessions and panes.
|
||||
|
||||
Watches for activity in multiple tmux sesstions and reports `session_name`, `window_name`, `pane_title`, `pane_current_command`, and `pane_current_path`.
|
||||
Watches for activity in multiple tmux sessions and reports `session_name`, `window_name`, `pane_title`, `pane_current_command`, and `pane_current_path`.
|
||||
|
||||
The plugin has been tested on Linux and is expected to work also on macOS and on Windows in Cygwin.
|
||||
|
||||
## How to install
|
||||
|
||||
Intall the [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) and install `akohlbecker/aw-watcher-tmux` as tmux plugin. More detailed instructions are found in the tmp README.
|
||||
### Requirements
|
||||
|
||||
* curl
|
||||
|
||||
### Preparation
|
||||
|
||||
Install the [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (tpm) and install `akohlbecker/aw-watcher-tmux` as tmux plugin.
|
||||
|
||||
### Install the aw-watcher-tmux plugin
|
||||
|
||||
1. Add below line to your `~/.tmux.conf`
|
||||
|
||||
~~~
|
||||
set -g @plugin 'akohlbecker/aw-watcher-tmux'
|
||||
~~~
|
||||
|
||||
2. Press prefix + I (capital i, as in Install) to fetch the plugin and reload the tmux environment. More detailed instructions are found in the [tpm](https://github.com/tmux-plugins/tpm) README.
|
||||
|
|
Loading…
Add table
Reference in a new issue