From 6e5222b9552460cee998a56a03c5ffc89d226a39 Mon Sep 17 00:00:00 2001 From: Huck Boles Date: Fri, 19 May 2023 08:50:08 -0500 Subject: [PATCH] edit: README typos and formatting --- README | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README b/README index a10c5f6..f806f18 100644 --- a/README +++ b/README @@ -1,18 +1,26 @@ ## zshmux 2.0 ### about -when a new shell is launched zshmux checks if there are any tmux sessions. -if you are not already in a tmux session zshmux will list all currently active sessions, + +when a new shell is launched **zshmux** checks if there are any **tmux** sessions. +if you are not already in a **tmux** session **zshmux** will list all currently active sessions, then ask if you want to attach a currently running session, or make a new session in the shell. -if there is only one tmux session running and not attached to any clients, zshmux +if there is only one **tmux** session running and not attached to any clients, **zshmux** will just automatically attach the session to the current shell. ### using -- add `[[ -d PATH/TO/ZSHMUX ]] && source PATH/TO/ZSHMUX/zshmux.sh` in your .zshrc -- open a new shell + +source **zshmux** in your *zshrc*: + + [[ -d PATH/TO/ZSHMUX ]] && source PATH/TO/ZSHMUX/zshmux.sh + +open a new shell ### other shells + zshmux should work with any bash compliant shell, as it no longer implements any zsh specific functions. ### installation -download or clone this repo and move `zshmux.zsh` to desired directory. then source in your `.shellrc` + +download or clone this repo and move *zshmux.sh* to desired directory. +then source in your *.zshrc* -- 2.44.2