commit 4f2e3009e43d43593f998dcb9c3030ee3464440b parent 892a94309f36d4e8cbfa03f6746f71e63fe5af56 Author: pyratebeard <root@pyratebeard.net> Date: Thu, 14 Jul 2022 14:11:20 +0100 usage after installation Diffstat:
| M | README.md | | | 30 | +++++++++++++++--------------- |
1 file changed, 15 insertions(+), 15 deletions(-)
diff --git a/README.md b/README.md @@ -2,21 +2,6 @@ A simple Pomodoro timer for your tmux statusline -## Usage -Add the format string `#{goldenapple}` in to your `status-right` or `status-left` option. - -Add the following bind-key options -``` -bind-key g run-shell "~/.tmux/plugins/tmux-golden-apple/golden_apple.tmux start" -bind-key G run-shell "~/.tmux/plugins/tmux-golden-apple/golden_apple.tmux stop" -``` - -By default the timer will run for 15 minutes. -You can modify the timer using the option `@work`, for example to set it for 30 minutes: -``` -set -g @work 30 -``` - ## Installation ### With [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (recommended) Add the plugin to your list of TPM plugins in `.tmux.conf` @@ -37,5 +22,20 @@ Reload your Tmux environment by typing the following in the terminal tmux source-file ~/.tmux.conf ``` +## Usage +Add the format string `#{goldenapple}` in to your `status-right` or `status-left` option. + +Add the following bind-key options +``` +bind-key g run-shell "~/.tmux/plugins/tmux-golden-apple/golden_apple.tmux start" +bind-key G run-shell "~/.tmux/plugins/tmux-golden-apple/golden_apple.tmux stop" +``` + +By default the timer will run for 15 minutes. +You can modify the timer using the option `@work`, for example to set it for 30 minutes: +``` +set -g @work 30 +``` + ## License [MIT](LICENSE)