diff --git a/README.md b/README.md index 68dc395..b1f0490 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ # ReMux: a friendlier tmux wrapper -The main point of this project is shortening commonly-used `tmux` -commands. -Attaching, pretty lists, and creating new sessions with group names -are currently implemented: +A tmux wrapper and command shortener written in Rust. ReMux's +goal is to wrap tmux commands to be both shorter, and oriented +around session names instead of session IDs. -```bash +In their shortest forms, *every* ReMux command is as short or +shorter than its equivalent tmux command: + +```sh # new session tmux new-session -t foo @@ -15,10 +17,19 @@ remux n foo # lists tmux ls remux l +remux # attach tmux a -t foo remux a foo +# has +tmux has -t foo +remux has foo + +# detach +tmux detach-client -t foo +remux d foo + ```