diff --git a/README.mkd b/README.mkd index a0266e6..83dd29e 100644 --- a/README.mkd +++ b/README.mkd @@ -1,6 +1,6 @@ # Introduction -Teamocil is a tool used to automatically create windows and splits in `tmux` with Ruby and YAML. Like [tmuxinator](https://github.com/aziz/tmuxinator), but with splits, not just windows. +Teamocil is a tool used to automatically create sessions, windows and splits in `tmux` with Ruby and YAML. Like [tmuxinator](https://github.com/aziz/tmuxinator), but with splits, not just windows. # Usage @@ -10,6 +10,11 @@ Teamocil is a tool used to automatically create windows and splits in `tmux` wit $ tmux $ teamocil sample +# Options + +* `--here` opens the session from the current window, it doesn’t create an empty first window. +* `--layout` takes a custom file path to a YAML layout file. + # Layout example # ~/.teamocil/sample.yml @@ -27,7 +32,7 @@ Teamocil is a tool used to automatically create windows and splits in `tmux` wit - cmd: memcached -p 11211 -vv height: 25 -will create a new window named `sample-window` with a layout like this: +Running `$ teamocil sample` will rename the session to `sample-session` and create a new window named `sample-window` with a layout like this: .------------------.------------------. | (0) | (1) |