]> git.huck.website - zshmux.git/commitdiff
edit: README typos and formatting
authorHuck Boles <huck@huck.website>
Fri, 19 May 2023 13:50:08 +0000 (08:50 -0500)
committerHuck Boles <huck@huck.website>
Fri, 19 May 2023 13:50:08 +0000 (08:50 -0500)
README

diff --git a/README b/README
index a10c5f63ea28b6d52fc5c0dd43411085937345fa..f806f180a4f87f3debe3a8118ea4fc10bd15179c 100644 (file)
--- 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*