updated README

This commit is contained in:
Valerie Wolfe 2024-03-06 16:05:53 -05:00
parent 63335916d9
commit 9c814c43f4

View file

@ -7,6 +7,10 @@ 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.
To further simplify developer usage, the `attach`, `detach`, `has`, and `new`
commands can be used without a target field, and will default to the name of
the Git repository root directory, if one is found.
In their shortest forms, *every* ReMux command is as short or
shorter than its equivalent tmux command:
@ -41,10 +45,6 @@ remux n -n foo
```
If you're working in a git repository, the `attach`, `detach`, `has`, and `new`
commands can be used without a session title, and the repository directory name
will be used instead.
## Dependencies
ReMux depends on [tmux](https://github.com/tmux/tmux).