README.md in termup-2.0.1 vs README.md in termup-2.0.2
- old
+ new
@@ -7,11 +7,11 @@
Compatible with Terminal.app and iTerm 2 on Mac OS X 10.6 - 10.8 and Ruby 1.8.7 - 1.9.3.
![Split Panes](https://github.com/kenn/termup/raw/master/images/split_panes.png)
-**iTerm 1 users** the current version is not compatible with iTerms 1. Use v1.3.1 - `gem install termup -v=1.3.1`
+**iTerm 1 users:** Termup 2.0 and up is not compatible with iTerm 1. Install 1.3.1 by `gem install termup -v=1.3.1`
Installation
------------
```sh
@@ -80,20 +80,28 @@
That's equivalent to `termup start myproject`.
### iTerm 2 Split Pane Support ###
-Specify iTerm option to use split pane.
+There are two options to deal with split panes on iTerm 2: `--iterm_basic` and `--iterm_advanced`
+#### --iterm_basic
+
+```sh
+termup create myproject --iterm_basic
+```
+
+This will generate additional options in the config file:
+
```yaml
options:
iterm:
width: 2
height: 2
```
-The setting above turns to:
+The setting above will generate four panes in the following layout.
#################
# # #
# 1 # 3 #
# # #
@@ -101,6 +109,69 @@
# # #
# 2 # 4 #
# # #
#################
-Enjoy!
+#### --iterm_advanced
+
+```sh
+termup create myproject --iterm_advanced
+```
+
+This will generate a config file in an advanced format:
+
+```yaml
+# COMMENT OF SCRIPT HERE
+---
+tabs:
+ pane1:
+ commands:
+ - echo tab1
+ layout:
+ - split_vertically
+ pane2:
+ commands:
+ - echo tab2
+ layout:
+ - split_horizontally
+ pane3:
+ commands:
+ - echo tab3
+ layout:
+ - split_horizontally
+ pane4:
+ commands:
+ - echo tab4
+```
+
+The setting above will generate four panes in the following layout.
+
+ #################
+ # # #
+ # # 2 #
+ # # #
+ # #########
+ # # #
+ # 1 # 3 #
+ # # #
+ # #########
+ # # #
+ # # 4 #
+ # # #
+ #################
+
+Available layout commands are:
+
+```ruby
+new_tab
+close_tab
+goto_previous_tab
+goto_next_tab
+goto_previous_pane
+goto_next_pane
+split_vertically
+split_horizontally
+go_left
+go_right
+go_down
+go_up
+```