added support for tpm, resolves #61

README.md

@@ -10,7 +10,7 @@ Installation
 
 Requirements:
 
-  - tmux **`>= 2.1`** (soon `>= 2.4`) running inside Linux, Mac, OpenBSD, Cygwin
+  - tmux **`>= 2.3`** (soon `>= 2.4`) running inside Linux, Mac, OpenBSD, Cygwin
     or WSL
   - awk, perl and sed
   - outside of tmux, `$TERM` must be set to `xterm-256color`
@@ -109,12 +109,12 @@ Features
    if available
  - laptop battery status line information
  - uptime status line information
- - optional highlight of focused pane (tmux `>= 2.1`)
+ - optional highlight of focused pane
  - configurable new windows and panes behavior (optionally retain current path)
  - SSH/Mosh aware split pane (reconnects to remote server)
  - copy to OS clipboard (needs [`reattach-to-user-namespace`][reattach-to-user-namespace]
    on macOS, `xsel` or `xclip` on Linux)
- - support for 4-digit hexadecimal Unicode characters (requires `perl` or Bash >= 4.1.2)
+ - support for 4-digit hexadecimal Unicode characters
  - [Facebook PathPicker][] integration if available
  - [Urlview][] integration if available
 
@@ -299,6 +299,22 @@ tmux_conf_theme_status_right='#(echo foo %% bar)'
 ```
 See `man 3 strftime`.
 
+### Using TPM plugins
+
+This configuration now comes with built-in [TPM] support:
+- use the `set -g @plugin ...` syntax to enable a plugin
+- whenever a plugin introduces a variable to be used in `status-left` or
+  `status-right`, you can use it in `tmux_conf_theme_status_left` and
+  `tmux_conf_theme_status_right` variables, see instructions above 👆
+- ⚠️ do not add `set -g @plugin 'tmux-plugins/tpm'`
+- ⚠️ do not add `run '~/.tmux/plugins/tpm/tpm'` to `~/.tmux.conf` or your
+- `~/.tmux.conf.local` copy ← people who are used to alter
+  `.tmux.conf` to add TPM support will have to adapt their configuration
+
+See `~/.tmux.conf.local` for instructions.
+
+[TPM]: https://github.com/tmux-plugins/tpm
+
 ### Accessing the macOS clipboard from within tmux sessions (tmux `< 2.6`)
 
 [Chris Johnsen created the `reattach-to-user-namespace`