diff --git a/plugins/tmux-autoattach/README.md b/plugins/tmux-autoattach/README.md index 0630b97..14781e3 100644 --- a/plugins/tmux-autoattach/README.md +++ b/plugins/tmux-autoattach/README.md @@ -1,8 +1,12 @@ -# tmux plugin +# tmux-autoattach.plugin -The tmux plugin will either attach or create a new tmux session for each bash session. If a session already exists, it will simply attach. +This tmux plugin will automatically attach a tmux session to your shell session. -## OSH_PLUGIN_TMUX_AUTOATTACH_BEHAVIOR +## Variables -| exit | This will completely close out your shell session, including your terminal, but keep your tmux sessions intact. This will also close your session if you detach. | -| detach | This will allow you to detach from the tmux screen without closing the terminal or shell session. | +#### OSH_PLUGIN_TMUX_AUTOATTACH_BEHAVIOR + +| Setting | Description | +|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| exit | This will completely close out your shell session, including your terminal, but keep your tmux sessions intact. This will also close your session if you detach. | +| detach | This will allow you to detach from the tmux screen without closing the terminal or shell session. |