diff --git a/README.md b/README.md index ace2f4d..59408e2 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,13 @@ The plugin has been tested on Linux and is expected to work also on macOS and on ### Requirements +* [ActivityWatch](https://activitywatch.net) * curl ### Preparation -Install the [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (tpm) and install `akohlbecker/aw-watcher-tmux` as tmux plugin. +1. Install **ActivityWatch** as described in the [getting-started](https://docs.activitywatch.net/en/latest/getting-started.html#installation) guide. +2. Install the [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (tpm) ### Install the aw-watcher-tmux plugin @@ -25,3 +27,11 @@ 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. + +## Usage + +Once the aw-watcher-tmux plugin is installed it monitors for user activity in all tmux sessions. Any activity is reported to the ActivityWatch REST API at [http://localhost:5600/api/](http://localhost:5600/api/). + +aw-watcher-tmux creates a new bucket. The existence of this bucket can be checked with [http://localhost:5600/api/0/buckets/aw-watcher-tmux](http://localhost:5600/api/0/buckets/aw-watcher-tmux). + +All activity recorded in this bucket can be seen on [http://localhost:5600/#/timeline](http://localhost:5600/#/timeline)